diff --git a/.github/workflows/cli-test-pipeline.yml b/.github/workflows/cli-test-pipeline.yml index 287cd146..70502b7d 100644 --- a/.github/workflows/cli-test-pipeline.yml +++ b/.github/workflows/cli-test-pipeline.yml @@ -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.6.1.52" + --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.8.1.126" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Use local provider diff --git a/.github/workflows/prep-internal-release.yml b/.github/workflows/prep-internal-release.yml index dc142cb3..d43cb4bb 100644 --- a/.github/workflows/prep-internal-release.yml +++ b/.github/workflows/prep-internal-release.yml @@ -85,7 +85,7 @@ jobs: sed -i "s/productName=.*$/productName=${{ github.event.repository.name }}/g" ci/whitesource/whitesource-agent.config sed -i "s/projectName=.*$/projectName=${{ github.event.repository.name }}/g" ci/whitesource/whitesource-agent.config cat ci/whitesource/whitesource-agent.config | grep productVersion - curl https://unified-agent.s3.amazonaws.com/wss-unified-agent.jar --output /ci/whitesource/wss-unified-agent.jar + curl https://unified-agent.s3.amazonaws.com/wss-unified-agent.jar --output ci/whitesource/wss-unified-agent.jar export WS_APIKEY="${{ secrets.WSS_API_KEY }}" export WS_WSS_URL="https://saas.whitesourcesoftware.com/agent" export WS_PRODUCTNAME="${{ github.event.repository.name }}" diff --git a/.github/workflows/provider-test-pipeline.yml b/.github/workflows/provider-test-pipeline.yml index 9334eb77..dc193262 100644 --- a/.github/workflows/provider-test-pipeline.yml +++ b/.github/workflows/provider-test-pipeline.yml @@ -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.6.1.52" + --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" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Use local provider @@ -69,6 +69,13 @@ jobs: terraform import solacebroker_msg_vpn.newone new popd + - name: Test broker object attributes override + run: | + pushd ci/brokertest + terraform apply -auto-approve + terraform plan | grep "No changes" + popd + - name: Test larger config run: | pushd ci/bigtest @@ -86,24 +93,23 @@ jobs: cat results.out | grep "401 Unauthorized" popd - # Skipping state upgrade test until using new SEMP schema - # - name: Test state upgrade - # 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" - # # TODO: GH actions fails on following commands, need to investigate - # # 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 + - name: Test state upgrade + 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/verify-registry-release.yml b/.github/workflows/verify-registry-release.yml index c52edb84..2e34d838 100644 --- a/.github/workflows/verify-registry-release.yml +++ b/.github/workflows/verify-registry-release.yml @@ -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.6.1.52" + --mount type=bind,source=$HOME/solace,destination=/var/lib/solace,ro=false solace/solace-pubsub-standard:"10.8.1.126" while ! curl -s localhost:8080 | grep aurelia ; do sleep 1 ; done - name: Set up Terraform latest - public diff --git a/README.md b/README.md index e6b8c4b3..d7e531da 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ The provider is available from the [Terraform Providers Registry](https://regist The minimum required PubSub+ Software Event Broker version is 10.4. +## Limitations + +> This version of the PubSub+ Terraform provider is generally available for production services contained within a Message VPN. Use of any resource not contained within a Message VPN is not supported in production by Solace. + ## Quick Start 1. Ensure you have admin access to a Solace PubSub+ Software Event Broker. Options include [local deployment of a containerized version](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm) or use of a free broker from [PubSub+ Cloud](https://docs.solace.com/Cloud/cloud-lp.htm). diff --git a/ci/brokertest/testconfig.tf b/ci/brokertest/testconfig.tf new file mode 100644 index 00000000..191eabe4 --- /dev/null +++ b/ci/brokertest/testconfig.tf @@ -0,0 +1,16 @@ +terraform { + required_providers { + solacebroker = { + source = "registry.terraform.io/solaceproducts/solacebroker" + } + } +} + +provider solacebroker { + username = "admin" + password = "admin" + url = "http://localhost:8080" +} + +resource "solacebroker_broker" "default" { +} diff --git a/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.1.30.vm.json b/ci/swagger_spec/semp-v2-swagger-config-extended.10.8.1.126.vm.json similarity index 95% rename from ci/swagger_spec/semp-v2-swagger-config-extended.10.6.1.30.vm.json rename to ci/swagger_spec/semp-v2-swagger-config-extended.10.8.1.126.vm.json index 7452c6fc..58211791 100644 --- a/ci/swagger_spec/semp-v2-swagger-config-extended.10.6.1.30.vm.json +++ b/ci/swagger_spec/semp-v2-swagger-config-extended.10.8.1.126.vm.json @@ -28,6 +28,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempVersion": { @@ -48,6 +49,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -137,6 +139,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "globalDmrBridgeAccessEnabled": { @@ -155,6 +158,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sessionActive": { @@ -173,6 +177,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sessionCreateTime": { @@ -194,6 +199,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sessionCurrentTime": { @@ -215,6 +221,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sessionHardExpiryTime": { @@ -236,6 +243,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sessionId": { @@ -256,6 +264,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sessionIdleExpiryTime": { @@ -277,6 +286,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "username": { @@ -297,6 +307,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -338,6 +349,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -359,6 +371,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -432,6 +445,29 @@ }, "Broker": { "properties": { + "authBruteForceProtectionEnabled": { + "description": "Enable or disable protection against brute force password guessing attacks on local management accounts. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.40.", + "type": "boolean", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "router", + "x-default": false, + "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 + }, "authClientCertRevocationCheckMode": { "description": "The client certificate revocation checking mode used when a client authenticates with a client certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Do not perform any certificate revocation checking.\n\"ocsp\" - Use the Open Certificate Status Protcol (OCSP) for certificate revocation checking.\n\"crl\" - Use Certificate Revocation Lists (CRL) for certificate revocation checking.\n\"ocsp-crl\" - Use OCSP first, but if OCSP fails to return an unambiguous result, then check via CRL.\n
\n", "enum": [ @@ -458,6 +494,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncAuthenticationClientCertMaxChainDepth": { @@ -482,6 +519,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncAuthenticationClientCertValidateDateEnabled": { @@ -503,6 +541,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncClientProfileTcpInitialCongestionWindow": { @@ -527,6 +566,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncClientProfileTcpKeepaliveCount": { @@ -551,6 +591,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncClientProfileTcpKeepaliveIdle": { @@ -575,6 +616,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncClientProfileTcpKeepaliveInterval": { @@ -599,6 +641,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncClientProfileTcpMaxWindow": { @@ -623,6 +666,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncClientProfileTcpMss": { @@ -647,6 +691,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncEnabled": { @@ -668,6 +713,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncSynchronizeUsernameEnabled": { @@ -690,6 +736,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "configSyncTlsEnabled": { @@ -711,6 +758,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingDefragmentationScheduleDayList": { @@ -735,6 +783,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingDefragmentationScheduleEnabled": { @@ -757,6 +806,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingDefragmentationScheduleTimeList": { @@ -781,6 +831,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingDefragmentationThresholdEnabled": { @@ -803,6 +854,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingDefragmentationThresholdFragmentationPercentage": { @@ -828,6 +880,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingDefragmentationThresholdMinInterval": { @@ -853,6 +906,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingDefragmentationThresholdUsagePercentage": { @@ -878,6 +932,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingEnabled": { @@ -899,6 +954,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingEventCacheUsageThreshold": { @@ -960,6 +1016,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingMaxMsgSpoolUsage": { @@ -985,6 +1042,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout": { @@ -1009,6 +1067,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout": { @@ -1033,6 +1092,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedMsgingTransactionReplicationCompatibilityMode": { @@ -1059,6 +1119,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileDefault": { @@ -1084,6 +1145,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceAmqpEnabled": { @@ -1106,6 +1168,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceAmqpTlsListenPort": { @@ -1133,6 +1196,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceEventConnectionCountThreshold": { @@ -1158,6 +1222,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceHealthCheckListenPort": { @@ -1185,6 +1250,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceHealthCheckTlsEnabled": { @@ -1207,6 +1273,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceHealthCheckTlsListenPort": { @@ -1234,6 +1301,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMateLinkEnabled": { @@ -1255,6 +1323,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMateLinkListenPort": { @@ -1281,6 +1350,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttEnabled": { @@ -1303,6 +1373,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMsgBackboneEnabled": { @@ -1324,6 +1395,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRedundancyEnabled": { @@ -1345,6 +1417,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRedundancyFirstListenPort": { @@ -1371,6 +1444,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestEventOutgoingConnectionCountThreshold": { @@ -1396,6 +1470,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestOutgoingEnabled": { @@ -1418,6 +1493,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempCorsAllowAnyHostEnabled": { @@ -1440,6 +1516,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempLegacyTimeoutEnabled": { @@ -1462,6 +1539,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempPlainTextEnabled": { @@ -1484,6 +1562,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempPlainTextListenPort": { @@ -1511,6 +1590,7 @@ "x-requiresDisable": [ "serviceSempPlainTextEnabled" ], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempSessionIdleTimeout": { @@ -1536,6 +1616,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempSessionMaxLifetime": { @@ -1561,6 +1642,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempTlsEnabled": { @@ -1583,6 +1665,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSempTlsListenPort": { @@ -1610,6 +1693,7 @@ "x-requiresDisable": [ "serviceSempTlsEnabled" ], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfCompressionListenPort": { @@ -1636,6 +1720,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfEnabled": { @@ -1657,6 +1742,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfEventConnectionCountThreshold": { @@ -1686,6 +1772,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfRoutingControlListenPort": { @@ -1712,6 +1799,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfTlsListenPort": { @@ -1738,6 +1826,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceTlsEventConnectionCountThreshold": { @@ -1763,6 +1852,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebTransportPlainTextListenPort": { @@ -1790,6 +1880,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebTransportTlsListenPort": { @@ -1817,6 +1908,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebTransportWebUrlSuffix": { @@ -1842,6 +1934,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsBlockVersion11Enabled": { @@ -1864,6 +1957,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsCipherSuiteManagementList": { @@ -1888,6 +1982,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsCipherSuiteMsgBackboneList": { @@ -1912,6 +2007,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsCipherSuiteSecureShellList": { @@ -1936,6 +2032,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsCrimeExploitProtectionEnabled": { @@ -1958,6 +2055,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsServerCertContent": { @@ -1980,6 +2078,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "tlsServerCertPassword": { @@ -2005,6 +2104,7 @@ "tlsServerCertContent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, "tlsStandardDomainCertificateAuthoritiesEnabled": { @@ -2026,6 +2126,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsTicketLifetime": { @@ -2051,6 +2152,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "webManagerAllowUnencryptedWizardsEnabled": { @@ -2073,6 +2175,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "webManagerCustomization": { @@ -2097,6 +2200,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "webManagerRedirectHttpEnabled": { @@ -2119,6 +2223,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "webManagerRedirectHttpOverrideTlsPort": { @@ -2144,6 +2249,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -2179,6 +2285,10 @@ "description": "The URI of this Broker's collection of OAuth Profile objects. Available since 2.24.", "type": "string" }, + "proxiesUri": { + "description": "The URI of this Broker's collection of Proxy objects. Available since 2.41.", + "type": "string" + }, "systemInformationUri": { "description": "The URI of this Broker's System Information object. Deprecated since 2.2. /systemInformation was replaced by /about/api.", "type": "string" @@ -2255,6 +2365,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "certContent": { @@ -2279,6 +2390,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "crlDayList": { @@ -2306,6 +2418,7 @@ "crlTimeList" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "crlTimeList": { @@ -2333,6 +2446,7 @@ "crlDayList" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "crlUrl": { @@ -2360,6 +2474,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspNonResponderCertEnabled": { @@ -2382,6 +2497,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspOverrideUrl": { @@ -2407,6 +2523,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspTimeout": { @@ -2432,6 +2549,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "revocationCheckEnabled": { @@ -2454,6 +2572,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -2498,6 +2617,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspTlsTrustedCommonName": { @@ -2518,6 +2638,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -2638,6 +2759,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "certContent": { @@ -2662,6 +2784,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "crlDayList": { @@ -2689,6 +2812,7 @@ "crlTimeList" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "crlTimeList": { @@ -2716,6 +2840,7 @@ "crlDayList" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "crlUrl": { @@ -2743,6 +2868,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspNonResponderCertEnabled": { @@ -2765,6 +2891,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspOverrideUrl": { @@ -2790,6 +2917,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspTimeout": { @@ -2815,6 +2943,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "revocationCheckEnabled": { @@ -2837,6 +2966,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -2881,6 +3011,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ocspTlsTrustedCommonName": { @@ -2901,6 +3032,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -2999,6 +3131,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationBasicPassword": { @@ -3024,6 +3157,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationBasicType": { @@ -3050,6 +3184,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertContent": { @@ -3074,6 +3209,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationClientCertEnabled": { @@ -3096,6 +3232,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertPassword": { @@ -3123,6 +3260,7 @@ "authenticationClientCertContent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, "directOnlyEnabled": { @@ -3143,6 +3281,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dmrClusterName": { @@ -3163,6 +3302,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -3185,6 +3325,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "nodeName": { @@ -3206,6 +3347,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsServerCertEnforceTrustedCommonNameEnabled": { @@ -3228,6 +3370,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsServerCertMaxChainDepth": { @@ -3253,6 +3396,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsServerCertValidateDateEnabled": { @@ -3275,6 +3419,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsServerCertValidateNameEnabled": { @@ -3297,6 +3442,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -3327,6 +3473,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -3349,6 +3496,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ruleName": { @@ -3369,6 +3517,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -3404,6 +3553,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "attributeValue": { @@ -3428,6 +3578,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dmrClusterName": { @@ -3448,6 +3599,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "filterName": { @@ -3469,6 +3621,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ruleName": { @@ -3489,6 +3642,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -3571,6 +3725,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dmrClusterName": { @@ -3591,6 +3746,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "expression": { @@ -3613,6 +3769,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ruleName": { @@ -3633,6 +3790,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "source": { @@ -3666,6 +3824,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -3807,6 +3966,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationScheme": { @@ -3835,6 +3995,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueControl1MaxDepth": { @@ -3860,6 +4021,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueControl1MinMsgBurst": { @@ -3885,6 +4047,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueDirect1MaxDepth": { @@ -3910,6 +4073,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueDirect1MinMsgBurst": { @@ -3935,6 +4099,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueDirect2MaxDepth": { @@ -3960,6 +4125,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueDirect2MinMsgBurst": { @@ -3985,6 +4151,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueDirect3MaxDepth": { @@ -4010,6 +4177,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueDirect3MinMsgBurst": { @@ -4035,6 +4203,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueGuaranteed1MaxDepth": { @@ -4060,6 +4229,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileQueueGuaranteed1MinMsgBurst": { @@ -4085,6 +4255,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileTcpCongestionWindowSize": { @@ -4110,6 +4281,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileTcpKeepaliveCount": { @@ -4135,6 +4307,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileTcpKeepaliveIdleTime": { @@ -4160,6 +4333,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileTcpKeepaliveInterval": { @@ -4185,6 +4359,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileTcpMaxSegmentSize": { @@ -4210,6 +4385,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileTcpMaxWindowSize": { @@ -4235,6 +4411,59 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + }, + "connectionRetryCount": { + "description": "The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.41.", + "format": "int64", + "maximum": 255, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "router", + "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 + }, + "connectionRetryDelay": { + "description": "The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. Available since 2.41.", + "format": "int64", + "maximum": 255, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": 3, + "x-configSyncTableType": "router", + "x-default": 3, + "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 }, "dmrClusterName": { @@ -4255,6 +4484,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "egressFlowWindowSize": { @@ -4282,6 +4512,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -4304,6 +4535,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "initiator": { @@ -4333,6 +4565,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDeadMsgQueue": { @@ -4358,6 +4591,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueEventSpoolUsageThreshold": { @@ -4386,6 +4620,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxMsgSpoolUsage": { @@ -4411,6 +4646,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxRedeliveryCount": { @@ -4436,6 +4672,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxTtl": { @@ -4461,6 +4698,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueRejectMsgToSenderOnDiscardBehavior": { @@ -4488,6 +4726,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueRespectTtlEnabled": { @@ -4510,6 +4749,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteNodeName": { @@ -4531,6 +4771,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "span": { @@ -4559,6 +4800,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportCompressedEnabled": { @@ -4583,6 +4825,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportTlsEnabled": { @@ -4607,6 +4850,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -4638,6 +4882,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "attributeValue": { @@ -4658,6 +4903,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dmrClusterName": { @@ -4678,6 +4924,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteNodeName": { @@ -4699,6 +4946,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -4812,6 +5060,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -4842,6 +5091,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -4874,6 +5124,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -4904,6 +5155,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -4929,13 +5181,14 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteAddress": { "description": "The FQDN or IP address (and optional port) of the remote node. If a port is not provided, it will vary based on the transport encoding: 55555 (plain-text), 55443 (encrypted), or 55003 (compressed).", "maxLength": 259, "minLength": 1, - "pattern": "^((([0-9a-zA-Z_\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})$", + "pattern": "^((([0-9a-zA-Z_\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})$", "type": "string", "x-accessLevels": { "get": "global/read-only" @@ -4950,6 +5203,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteNodeName": { @@ -4971,6 +5225,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5067,6 +5322,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteNodeName": { @@ -5088,6 +5344,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsTrustedCommonName": { @@ -5108,6 +5365,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5291,6 +5549,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "certContent": { @@ -5315,6 +5574,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5384,6 +5644,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -5414,6 +5675,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -5446,6 +5708,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -5476,6 +5739,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5510,6 +5774,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -5538,6 +5803,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5572,6 +5838,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -5600,6 +5867,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5638,6 +5906,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -5668,6 +5937,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -5700,6 +5970,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -5730,6 +6001,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5768,6 +6040,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -5798,6 +6071,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -5830,6 +6104,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -5860,6 +6135,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -5898,6 +6174,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -5928,6 +6205,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -5960,6 +6238,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -5990,6 +6269,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -6024,6 +6304,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -6052,6 +6333,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -6086,6 +6368,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -6114,6 +6397,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -6152,6 +6436,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -6182,6 +6467,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -6214,6 +6500,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -6244,6 +6531,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -6282,6 +6570,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -6312,6 +6601,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -6344,6 +6634,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -6374,6 +6665,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -6408,6 +6700,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -6436,6 +6729,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -6474,6 +6768,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -6504,6 +6799,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -6536,6 +6832,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -6566,6 +6863,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -6596,6 +6894,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationBasicEnabled": { @@ -6618,6 +6917,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationBasicProfileName": { @@ -6646,6 +6946,7 @@ "authenticationBasicType" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationBasicRadiusDomain": { @@ -6670,6 +6971,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationBasicType": { @@ -6698,10 +7000,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertAllowApiProvidedUsernameEnabled": { - "description": "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -6720,6 +7023,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertCertificateMatchingRulesEnabled": { @@ -6742,10 +7046,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertEnabled": { - "description": "Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable client certificate authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -6764,6 +7069,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertMaxChainDepth": { @@ -6789,6 +7095,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertRevocationCheckMode": { @@ -6816,6 +7123,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertUsernameSource": { @@ -6846,6 +7154,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertValidateDateEnabled": { @@ -6868,10 +7177,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationKerberosAllowApiProvidedUsernameEnabled": { - "description": "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -6890,10 +7200,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationKerberosEnabled": { - "description": "Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "description": "Enable or disable Kerberos authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -6912,6 +7223,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthDefaultProfileName": { @@ -6937,6 +7249,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthDefaultProviderName": { @@ -6962,10 +7275,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthEnabled": { - "description": "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.", + "description": "Enable or disable OAuth authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.", "type": "boolean", "x-accessLevels": { "get": "vpn/read-only", @@ -6984,6 +7298,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationLdapGroupMembershipAttributeName": { @@ -7008,6 +7323,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationLdapTrimClientUsernameDomainEnabled": { @@ -7030,6 +7346,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationProfileName": { @@ -7058,6 +7375,7 @@ "authorizationType" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationType": { @@ -7084,6 +7402,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgingTlsServerCertEnforceTrustedCommonNameEnabled": { @@ -7106,6 +7425,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgingTlsServerCertMaxChainDepth": { @@ -7131,6 +7451,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgingTlsServerCertValidateDateEnabled": { @@ -7153,6 +7474,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgingTlsServerCertValidateNameEnabled": { @@ -7175,6 +7497,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "distributedCacheManagementEnabled": { @@ -7196,6 +7519,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dmrEnabled": { @@ -7218,6 +7542,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -7240,6 +7565,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventConnectionCountThreshold": { @@ -7283,6 +7609,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventLogTag": { @@ -7307,6 +7634,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventMsgSpoolUsageThreshold": { @@ -7332,6 +7660,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventPublishMsgVpnEnabled": { @@ -7354,6 +7683,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventPublishSubscriptionMode": { @@ -7383,6 +7713,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventPublishTopicFormatMqttEnabled": { @@ -7408,6 +7739,7 @@ "eventPublishTopicFormatSmfEnabled" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventPublishTopicFormatSmfEnabled": { @@ -7433,6 +7765,7 @@ "eventPublishTopicFormatMqttEnabled" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventServiceAmqpConnectionCountThreshold": { @@ -7479,6 +7812,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "jndiEnabled": { @@ -7501,6 +7835,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxConnectionCount": { @@ -7524,6 +7859,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxEgressFlowCount": { @@ -7549,6 +7885,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxEndpointCount": { @@ -7574,6 +7911,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxIngressFlowCount": { @@ -7599,6 +7937,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxKafkaBrokerConnectionCount": { @@ -7622,6 +7961,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSpoolUsage": { @@ -7647,10 +7987,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxSubscriptionCount": { - "description": "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + "description": "The maximum number of local subscriptions that can be added to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500000`.", "format": "int64", "maximum": 4294967295, "minimum": 0, @@ -7660,7 +8001,9 @@ "patch": "global/read-write" }, "x-autoDisable": [], + "x-configSyncDefault": 500000, "x-configSyncTableType": "vpn", + "x-default": 500000, "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -7670,6 +8013,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTransactedSessionCount": { @@ -7693,6 +8037,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTransactionCount": { @@ -7716,6 +8061,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "mqttRetainMaxMemory": { @@ -7741,6 +8087,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -7762,6 +8109,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationAckPropagationIntervalMsgCount": { @@ -7787,6 +8135,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationBridgeAuthenticationBasicClientUsername": { @@ -7815,6 +8164,7 @@ "replicationBridgeAuthenticationBasicPassword" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationBridgeAuthenticationBasicPassword": { @@ -7841,6 +8191,7 @@ "replicationBridgeAuthenticationBasicClientUsername" ], "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "replicationBridgeAuthenticationClientCertContent": { @@ -7863,6 +8214,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "replicationBridgeAuthenticationClientCertPassword": { @@ -7888,6 +8240,7 @@ "replicationBridgeAuthenticationClientCertContent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, "replicationBridgeAuthenticationScheme": { @@ -7914,6 +8267,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationBridgeCompressedDataEnabled": { @@ -7936,6 +8290,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationBridgeEgressFlowWindowSize": { @@ -7961,6 +8316,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationBridgeRetryDelay": { @@ -7986,6 +8342,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationBridgeTlsEnabled": { @@ -8008,6 +8365,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationBridgeUnidirectionalClientProfileName": { @@ -8033,6 +8391,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationEnabled": { @@ -8055,6 +8414,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationEnabledQueueBehavior": { @@ -8084,6 +8444,7 @@ "replicationEnabled" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, "replicationQueueMaxMsgSpoolUsage": { @@ -8109,6 +8470,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationQueueRejectMsgToSenderOnDiscardEnabled": { @@ -8131,6 +8493,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationRejectMsgWhenSyncIneligibleEnabled": { @@ -8153,6 +8516,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationRole": { @@ -8179,6 +8543,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationTransactionMode": { @@ -8205,6 +8570,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restTlsServerCertEnforceTrustedCommonNameEnabled": { @@ -8227,6 +8593,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restTlsServerCertMaxChainDepth": { @@ -8252,6 +8619,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restTlsServerCertValidateDateEnabled": { @@ -8274,6 +8642,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restTlsServerCertValidateNameEnabled": { @@ -8296,6 +8665,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempOverMsgBusAdminClientEnabled": { @@ -8318,6 +8688,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempOverMsgBusAdminDistributedCacheEnabled": { @@ -8340,6 +8711,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempOverMsgBusAdminEnabled": { @@ -8362,6 +8734,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempOverMsgBusEnabled": { @@ -8384,6 +8757,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempOverMsgBusShowEnabled": { @@ -8406,6 +8780,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceAmqpMaxConnectionCount": { @@ -8429,6 +8804,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceAmqpPlainTextEnabled": { @@ -8451,6 +8827,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceAmqpPlainTextListenPort": { @@ -8478,6 +8855,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceAmqpTlsEnabled": { @@ -8500,6 +8878,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceAmqpTlsListenPort": { @@ -8527,6 +8906,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttAuthenticationClientCertRequest": { @@ -8554,6 +8934,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttMaxConnectionCount": { @@ -8577,6 +8958,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttPlainTextEnabled": { @@ -8599,6 +8981,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttPlainTextListenPort": { @@ -8626,6 +9009,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttTlsEnabled": { @@ -8648,6 +9032,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttTlsListenPort": { @@ -8675,6 +9060,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttTlsWebSocketEnabled": { @@ -8697,6 +9083,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttTlsWebSocketListenPort": { @@ -8724,6 +9111,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttWebSocketEnabled": { @@ -8746,6 +9134,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMqttWebSocketListenPort": { @@ -8773,6 +9162,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestIncomingAuthenticationClientCertRequest": { @@ -8800,6 +9190,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestIncomingAuthorizationHeaderHandling": { @@ -8827,6 +9218,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestIncomingMaxConnectionCount": { @@ -8850,6 +9242,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestIncomingPlainTextEnabled": { @@ -8872,6 +9265,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestIncomingPlainTextListenPort": { @@ -8899,6 +9293,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestIncomingTlsEnabled": { @@ -8921,6 +9316,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestIncomingTlsListenPort": { @@ -8948,6 +9344,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestMode": { @@ -8974,6 +9371,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceRestOutgoingMaxConnectionCount": { @@ -8997,6 +9395,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfMaxConnectionCount": { @@ -9020,6 +9419,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfPlainTextEnabled": { @@ -9042,6 +9442,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfTlsEnabled": { @@ -9064,6 +9465,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebAuthenticationClientCertRequest": { @@ -9091,6 +9493,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebMaxConnectionCount": { @@ -9114,6 +9517,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebPlainTextEnabled": { @@ -9136,6 +9540,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebTlsEnabled": { @@ -9158,6 +9563,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsAllowDowngradeToPlainTextEnabled": { @@ -9180,6 +9586,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -9210,6 +9617,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientConnectDefaultAction": { @@ -9236,6 +9644,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -9257,6 +9666,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "publishTopicDefaultAction": { @@ -9283,6 +9693,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscribeShareNameDefaultAction": { @@ -9309,6 +9720,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscribeTopicDefaultAction": { @@ -9335,6 +9747,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -9365,6 +9778,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientConnectExceptionAddress": { @@ -9386,6 +9800,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -9407,6 +9822,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -9519,6 +9935,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -9540,6 +9957,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "publishExceptionTopic": { @@ -9560,6 +9978,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicSyntax": { @@ -9582,6 +10001,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -9661,6 +10081,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -9682,6 +10103,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "publishTopicException": { @@ -9702,6 +10124,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "publishTopicExceptionSyntax": { @@ -9724,6 +10147,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -9820,6 +10244,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -9841,6 +10266,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscribeExceptionTopic": { @@ -9861,6 +10287,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicSyntax": { @@ -9883,6 +10310,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -9962,6 +10390,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -9983,6 +10412,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscribeShareNameException": { @@ -10003,6 +10433,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscribeShareNameExceptionSyntax": { @@ -10025,6 +10456,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -10104,6 +10536,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -10125,6 +10558,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscribeTopicException": { @@ -10145,6 +10579,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscribeTopicExceptionSyntax": { @@ -10167,6 +10602,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -10249,6 +10685,160 @@ ], "type": "object" }, + "MsgVpnAuthenticationKerberosRealm": { + "properties": { + "enabled": { + "description": "Enable or disable the Realm. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + "type": "boolean", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "vpn", + "x-default": false, + "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 + }, + "kdcAddress": { + "description": "Address (FQDN or IP) and optional port of the Key Distribution Center for principals in this 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 `\"\"`.", + "maxLength": 259, + "minLength": 0, + "pattern": "^(((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1}))?$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "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 + }, + "kerberosRealmName": { + "description": "The Realm Name. Must start with \"@\", typically all uppercase.", + "maxLength": 254, + "minLength": 2, + "pattern": "^@.+$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only" + }, + "x-autoDisable": [], + "x-deprecated": false, + "x-identifying": true, + "x-identifyingDirect": true, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": true, + "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + }, + "msgVpnName": { + "description": "The name of the Message VPN.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^*?]+$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only" + }, + "x-autoDisable": [], + "x-deprecated": false, + "x-identifying": true, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": true, + "x-readOptional": false, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + } + }, + "type": "object", + "x-accessLevels": { + "delete": "vpn/read-write", + "post": "vpn/read-write" + }, + "x-configSyncTableTypeCreateDelete": "vpn" + }, + "MsgVpnAuthenticationKerberosRealmLinks": { + "properties": { + "uri": { + "description": "The URI of this Realm object.", + "type": "string" + } + }, + "type": "object" + }, + "MsgVpnAuthenticationKerberosRealmResponse": { + "properties": { + "data": { + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealm" + }, + "links": { + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealmLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "MsgVpnAuthenticationKerberosRealmsResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealm" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealmLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, "MsgVpnAuthenticationOauthProfile": { "properties": { "authorizationGroupsClaimName": { @@ -10273,6 +10863,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationGroupsClaimStringFormat": { @@ -10299,6 +10890,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientId": { @@ -10323,6 +10915,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientRequiredType": { @@ -10347,6 +10940,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientSecret": { @@ -10370,6 +10964,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "clientValidateTypeEnabled": { @@ -10392,6 +10987,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "disconnectOnTokenExpirationEnabled": { @@ -10414,6 +11010,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -10436,6 +11033,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointDiscovery": { @@ -10460,6 +11058,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointDiscoveryRefreshInterval": { @@ -10485,6 +11084,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointIntrospection": { @@ -10509,6 +11109,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointIntrospectionTimeout": { @@ -10534,6 +11135,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointJwks": { @@ -10558,6 +11160,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointJwksRefreshInterval": { @@ -10583,6 +11186,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointUserinfo": { @@ -10607,6 +11211,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointUserinfoTimeout": { @@ -10632,6 +11237,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "issuer": { @@ -10656,6 +11262,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "mqttUsernameValidateEnabled": { @@ -10678,6 +11285,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -10699,6 +11307,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -10720,6 +11329,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthRole": { @@ -10746,6 +11356,32 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + }, + "proxyName": { + "description": "The name of the proxy to use for discovery, user info, jwks, and introspection requests. 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.41.", + "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 }, "resourceServerParseAccessTokenEnabled": { @@ -10768,6 +11404,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredAudience": { @@ -10792,6 +11429,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredIssuer": { @@ -10816,6 +11454,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredScope": { @@ -10840,6 +11479,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredType": { @@ -10864,6 +11504,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateAudienceEnabled": { @@ -10886,6 +11527,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateIssuerEnabled": { @@ -10908,6 +11550,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateScopeEnabled": { @@ -10930,6 +11573,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateTypeEnabled": { @@ -10952,6 +11596,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "usernameClaimName": { @@ -10976,6 +11621,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -11006,6 +11652,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientRequiredClaimValue": { @@ -11026,6 +11673,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -11047,6 +11695,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -11068,6 +11717,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -11165,6 +11815,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -11186,6 +11837,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredClaimName": { @@ -11206,6 +11858,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredClaimValue": { @@ -11226,6 +11879,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -11349,6 +12003,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "audienceClaimSource": { @@ -11376,6 +12031,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "audienceClaimValue": { @@ -11400,6 +12056,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "audienceValidationEnabled": { @@ -11422,6 +12079,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationGroupClaimName": { @@ -11446,6 +12104,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationGroupClaimSource": { @@ -11473,6 +12132,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationGroupEnabled": { @@ -11495,6 +12155,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "disconnectOnTokenExpirationEnabled": { @@ -11517,6 +12178,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -11539,6 +12201,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "jwksRefreshInterval": { @@ -11564,6 +12227,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "jwksUri": { @@ -11588,6 +12252,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -11609,6 +12274,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProviderName": { @@ -11630,6 +12296,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tokenIgnoreTimeLimitsEnabled": { @@ -11652,6 +12319,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tokenIntrospectionParameterName": { @@ -11676,6 +12344,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tokenIntrospectionPassword": { @@ -11699,6 +12368,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "tokenIntrospectionTimeout": { @@ -11724,6 +12394,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tokenIntrospectionUri": { @@ -11748,6 +12419,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tokenIntrospectionUsername": { @@ -11772,6 +12444,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "usernameClaimName": { @@ -11796,6 +12469,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "usernameClaimSource": { @@ -11823,6 +12497,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "usernameValidateEnabled": { @@ -11845,6 +12520,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -11930,6 +12606,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationGroupName": { @@ -11950,6 +12627,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileName": { @@ -11977,6 +12655,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -11999,6 +12678,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -12020,6 +12700,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "orderAfterAuthorizationGroupName": { @@ -12044,6 +12725,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, "orderBeforeAuthorizationGroupName": { @@ -12068,6 +12750,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true } }, @@ -12148,6 +12831,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgeVirtualRouter": { @@ -12171,6 +12855,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -12193,6 +12878,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTtl": { @@ -12220,6 +12906,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -12241,6 +12928,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteAuthenticationBasicClientUsername": { @@ -12271,6 +12959,7 @@ "remoteAuthenticationBasicPassword" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteAuthenticationBasicPassword": { @@ -12299,6 +12988,7 @@ "remoteAuthenticationBasicClientUsername" ], "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "remoteAuthenticationClientCertContent": { @@ -12323,6 +13013,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "remoteAuthenticationClientCertPassword": { @@ -12350,6 +13041,7 @@ "remoteAuthenticationClientCertContent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, "remoteAuthenticationScheme": { @@ -12378,10 +13070,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteConnectionRetryCount": { - "description": "The maximum number of retry attempts to establish a connection to the remote Message VPN. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + "description": "The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", "format": "int64", "maximum": 255, "minimum": 0, @@ -12403,6 +13096,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteConnectionRetryDelay": { @@ -12428,6 +13122,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteDeliverToOnePriority": { @@ -12459,6 +13154,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsCipherSuiteList": { @@ -12483,6 +13179,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -12535,6 +13232,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgeVirtualRouter": { @@ -12558,6 +13256,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientUsername": { @@ -12588,6 +13287,7 @@ "password" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "compressedDataEnabled": { @@ -12612,6 +13312,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "connectOrder": { @@ -12637,6 +13338,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "egressFlowWindowSize": { @@ -12664,6 +13366,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -12686,6 +13389,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -12707,6 +13411,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "password": { @@ -12735,6 +13440,7 @@ "clientUsername" ], "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "queueBinding": { @@ -12760,6 +13466,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteMsgVpnInterface": { @@ -12780,6 +13487,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteMsgVpnLocation": { @@ -12801,6 +13509,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteMsgVpnName": { @@ -12822,6 +13531,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsEnabled": { @@ -12846,6 +13556,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "unidirectionalClientProfile": { @@ -12871,6 +13582,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -12951,6 +13663,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgeVirtualRouter": { @@ -12974,6 +13687,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliverAlwaysEnabled": { @@ -12992,6 +13706,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -13013,6 +13728,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteSubscriptionTopic": { @@ -13033,6 +13749,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -13130,6 +13847,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bridgeVirtualRouter": { @@ -13153,6 +13871,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -13174,6 +13893,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsTrustedCommonName": { @@ -13194,6 +13914,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -13298,6 +14019,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -13319,6 +14041,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ruleName": { @@ -13339,6 +14062,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -13374,6 +14098,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "attributeValue": { @@ -13398,6 +14123,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "filterName": { @@ -13419,6 +14145,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -13440,6 +14167,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ruleName": { @@ -13460,6 +14188,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -13542,6 +14271,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "expression": { @@ -13564,6 +14294,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -13585,6 +14316,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ruleName": { @@ -13605,6 +14337,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "source": { @@ -13638,6 +14371,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -13776,6 +14510,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "allowCutThroughForwardingEnabled": { @@ -13798,6 +14533,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "allowGuaranteedEndpointCreateDurability": { @@ -13825,6 +14561,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "allowGuaranteedEndpointCreateEnabled": { @@ -13847,6 +14584,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "allowGuaranteedMsgReceiveEnabled": { @@ -13869,6 +14607,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "allowGuaranteedMsgSendEnabled": { @@ -13891,6 +14630,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "allowSharedSubscriptionsEnabled": { @@ -13913,6 +14653,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "allowTransactedSessionsEnabled": { @@ -13935,6 +14676,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "apiQueueManagementCopyFromOnCreateName": { @@ -13960,6 +14702,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "apiQueueManagementCopyFromOnCreateTemplateName": { @@ -13985,6 +14728,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "apiTopicEndpointManagementCopyFromOnCreateName": { @@ -14009,6 +14753,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "apiTopicEndpointManagementCopyFromOnCreateTemplateName": { @@ -14034,6 +14779,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileName": { @@ -14055,6 +14801,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "compressionEnabled": { @@ -14077,6 +14824,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "elidingDelay": { @@ -14102,6 +14850,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "elidingEnabled": { @@ -14124,6 +14873,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "elidingMaxTopicCount": { @@ -14149,6 +14899,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventClientProvisionedEndpointSpoolUsageThreshold": { @@ -14202,6 +14953,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxEgressFlowCount": { @@ -14227,6 +14979,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxEndpointCountPerClientUsername": { @@ -14252,6 +15005,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxIngressFlowCount": { @@ -14277,6 +15031,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgsPerTransaction": { @@ -14302,6 +15057,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxSubscriptionCount": { @@ -14325,6 +15081,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTransactedSessionCount": { @@ -14350,6 +15107,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTransactionCount": { @@ -14373,6 +15131,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -14394,6 +15153,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueControl1MaxDepth": { @@ -14419,6 +15179,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueControl1MinMsgBurst": { @@ -14444,6 +15205,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDirect1MaxDepth": { @@ -14469,6 +15231,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDirect1MinMsgBurst": { @@ -14494,6 +15257,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDirect2MaxDepth": { @@ -14519,6 +15283,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDirect2MinMsgBurst": { @@ -14544,6 +15309,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDirect3MaxDepth": { @@ -14569,6 +15335,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDirect3MinMsgBurst": { @@ -14594,6 +15361,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueGuaranteed1MaxDepth": { @@ -14619,6 +15387,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueGuaranteed1MinMsgBurst": { @@ -14644,6 +15413,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectMsgToSenderOnNoSubscriptionMatchEnabled": { @@ -14666,6 +15436,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationAllowClientConnectWhenStandbyEnabled": { @@ -14688,6 +15459,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceMinKeepaliveTimeout": { @@ -14713,6 +15485,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfMaxConnectionCountPerClientUsername": { @@ -14736,6 +15509,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceSmfMinKeepaliveEnabled": { @@ -14758,6 +15532,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebInactiveTimeout": { @@ -14783,6 +15558,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebMaxConnectionCountPerClientUsername": { @@ -14806,6 +15582,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "serviceWebMaxPayload": { @@ -14831,6 +15608,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tcpCongestionWindowSize": { @@ -14856,6 +15634,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tcpKeepaliveCount": { @@ -14881,6 +15660,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tcpKeepaliveIdleTime": { @@ -14906,6 +15686,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tcpKeepaliveInterval": { @@ -14931,6 +15712,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tcpMaxSegmentSize": { @@ -14956,6 +15738,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tcpMaxWindowSize": { @@ -14981,6 +15764,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsAllowDowngradeToPlainTextEnabled": { @@ -15003,6 +15787,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15042,6 +15827,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15070,6 +15856,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15108,6 +15895,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -15138,6 +15926,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15170,6 +15959,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -15200,6 +15990,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15238,6 +16029,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -15268,6 +16060,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15300,6 +16093,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -15330,6 +16124,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15368,6 +16163,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -15398,6 +16194,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15430,6 +16227,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -15460,6 +16258,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15498,6 +16297,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -15528,6 +16328,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15560,6 +16361,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -15590,6 +16392,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15628,6 +16431,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -15658,6 +16462,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15690,6 +16495,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -15720,6 +16526,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15758,6 +16565,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -15788,6 +16596,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15820,6 +16629,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -15850,6 +16660,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -15888,6 +16699,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -15918,6 +16730,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -15950,6 +16763,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -15980,6 +16794,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -16018,6 +16833,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -16048,6 +16864,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -16080,6 +16897,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -16110,6 +16928,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -16148,6 +16967,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -16178,6 +16998,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -16210,6 +17031,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -16240,6 +17062,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -16320,6 +17143,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientProfileName": { @@ -16347,6 +17171,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientUsername": { @@ -16368,6 +17193,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -16390,6 +17216,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedEndpointPermissionOverrideEnabled": { @@ -16412,6 +17239,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -16433,6 +17261,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "password": { @@ -16456,6 +17285,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "subscriptionManagerEnabled": { @@ -16478,6 +17308,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -16509,6 +17340,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "attributeValue": { @@ -16529,6 +17361,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientUsername": { @@ -16550,6 +17383,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -16571,6 +17405,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -16704,6 +17539,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "cacheVirtualRouter": { @@ -16727,6 +17563,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -16749,6 +17586,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "heartbeat": { @@ -16774,6 +17612,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -16795,6 +17634,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "scheduledDeleteMsgDayList": { @@ -16822,6 +17662,7 @@ "scheduledDeleteMsgTimeList" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "scheduledDeleteMsgTimeList": { @@ -16849,6 +17690,7 @@ "scheduledDeleteMsgDayList" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -16880,6 +17722,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clusterName": { @@ -16901,6 +17744,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliverToOneOverrideEnabled": { @@ -16925,6 +17769,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -16947,6 +17792,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventDataByteRateThreshold": { @@ -16990,6 +17836,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "globalCachingHeartbeat": { @@ -17015,6 +17862,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "globalCachingTopicLifetime": { @@ -17040,6 +17888,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMemory": { @@ -17065,6 +17914,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgsPerTopic": { @@ -17090,6 +17940,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxRequestQueueDepth": { @@ -17115,6 +17966,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTopicCount": { @@ -17140,6 +17992,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgLifetime": { @@ -17165,6 +18018,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -17186,6 +18040,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "newTopicAdvertisementEnabled": { @@ -17208,6 +18063,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17247,6 +18103,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -17275,6 +18132,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17309,6 +18167,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -17337,6 +18196,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17371,6 +18231,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -17399,6 +18260,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17433,6 +18295,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -17461,6 +18324,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17495,6 +18359,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -17523,6 +18388,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17557,6 +18423,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -17585,6 +18452,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17619,6 +18487,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -17647,6 +18516,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17673,6 +18543,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clusterName": { @@ -17694,6 +18565,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "homeClusterName": { @@ -17715,6 +18587,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -17736,6 +18609,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17797,6 +18671,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clusterName": { @@ -17818,6 +18693,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "homeClusterName": { @@ -17839,6 +18715,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -17860,10 +18737,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicPrefix": { - "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + "description": "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", "maxLength": 250, "minLength": 1, "type": "string", @@ -17880,6 +18758,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -17984,6 +18863,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "cacheName": { @@ -18005,6 +18885,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clusterName": { @@ -18026,6 +18907,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -18048,6 +18930,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "instanceName": { @@ -18069,6 +18952,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -18090,6 +18974,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "stopOnLostMsgEnabled": { @@ -18112,6 +18997,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -18230,6 +19116,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clusterName": { @@ -18251,6 +19138,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -18272,6 +19160,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topic": { @@ -18292,6 +19181,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -18448,6 +19338,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteMsgVpnName": { @@ -18473,6 +19364,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteNodeName": { @@ -18494,6 +19386,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -18586,6 +19479,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -18616,6 +19510,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -18648,6 +19543,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -18678,6 +19574,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -18716,6 +19613,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -18746,6 +19644,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -18778,6 +19677,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -18808,6 +19708,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -18842,6 +19743,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -18870,6 +19772,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -18908,6 +19811,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -18938,6 +19842,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -18970,6 +19875,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19000,6 +19906,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19038,6 +19945,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -19068,6 +19976,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -19100,6 +20009,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19130,6 +20040,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19164,6 +20075,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19192,6 +20104,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19230,6 +20143,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -19260,6 +20174,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -19292,6 +20207,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19322,6 +20238,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19360,6 +20277,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -19390,6 +20308,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -19422,6 +20341,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19452,6 +20372,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19490,6 +20411,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -19520,6 +20442,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -19552,6 +20475,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19582,6 +20506,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19620,6 +20545,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -19650,6 +20576,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -19682,6 +20609,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19712,6 +20640,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19750,6 +20679,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -19780,6 +20710,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -19812,6 +20743,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19842,6 +20774,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -19880,6 +20813,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -19910,6 +20844,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -19942,6 +20877,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -19972,6 +20908,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -20010,6 +20947,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -20040,6 +20978,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -20072,6 +21011,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -20102,6 +21042,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -20140,6 +21081,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -20170,6 +21112,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -20202,6 +21145,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -20232,6 +21176,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -20270,6 +21215,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -20300,6 +21246,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -20332,6 +21279,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -20362,6 +21310,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -20412,6 +21361,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientDescription": { @@ -20436,6 +21386,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientId": { @@ -20460,6 +21411,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "connectionFactoryName": { @@ -20481,6 +21433,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dtoReceiveOverrideEnabled": { @@ -20503,6 +21456,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dtoReceiveSubscriberLocalPriority": { @@ -20528,6 +21482,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dtoReceiveSubscriberNetworkPriority": { @@ -20553,6 +21508,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dtoSendEnabled": { @@ -20575,6 +21531,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dynamicEndpointCreateDurableEnabled": { @@ -20597,6 +21554,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "dynamicEndpointRespectTtlEnabled": { @@ -20619,6 +21577,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedReceiveAckTimeout": { @@ -20644,6 +21603,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedReceiveReconnectRetryCount": { @@ -20669,6 +21629,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedReceiveReconnectRetryWait": { @@ -20694,6 +21655,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedReceiveWindowSize": { @@ -20719,6 +21681,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedReceiveWindowSizeAckThreshold": { @@ -20744,6 +21707,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedSendAckTimeout": { @@ -20769,6 +21733,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "guaranteedSendWindowSize": { @@ -20794,6 +21759,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "messagingDefaultDeliveryMode": { @@ -20820,6 +21786,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "messagingDefaultDmqEligibleEnabled": { @@ -20842,6 +21809,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "messagingDefaultElidingEligibleEnabled": { @@ -20864,6 +21832,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "messagingJmsxUserIdEnabled": { @@ -20886,6 +21855,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "messagingTextInXmlPayloadEnabled": { @@ -20908,6 +21878,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -20929,6 +21900,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportCompressionLevel": { @@ -20954,6 +21926,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportConnectRetryCount": { @@ -20979,6 +21952,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportConnectRetryPerHostCount": { @@ -21004,6 +21978,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportConnectTimeout": { @@ -21029,6 +22004,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportDirectTransportEnabled": { @@ -21051,6 +22027,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportKeepaliveCount": { @@ -21076,6 +22053,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportKeepaliveEnabled": { @@ -21098,6 +22076,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportKeepaliveInterval": { @@ -21123,6 +22102,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportMsgCallbackOnIoThreadEnabled": { @@ -21145,6 +22125,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportOptimizeDirectEnabled": { @@ -21167,6 +22148,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportPort": { @@ -21192,6 +22174,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportReadTimeout": { @@ -21217,6 +22200,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportReceiveBufferSize": { @@ -21242,6 +22226,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportReconnectRetryCount": { @@ -21267,6 +22252,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportReconnectRetryWait": { @@ -21292,6 +22278,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportSendBufferSize": { @@ -21317,6 +22304,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportTcpNoDelayEnabled": { @@ -21339,6 +22327,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "xaEnabled": { @@ -21361,6 +22350,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -21418,6 +22408,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "physicalName": { @@ -21442,6 +22433,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueName": { @@ -21463,6 +22455,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -21543,6 +22536,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "physicalName": { @@ -21567,6 +22561,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicName": { @@ -21588,6 +22583,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -21675,6 +22671,7 @@ "authenticationBasicUsername" ], "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationBasicUsername": { @@ -21701,6 +22698,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertContent": { @@ -21725,6 +22723,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationClientCertPassword": { @@ -21752,11 +22751,41 @@ "authenticationClientCertContent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, - "authenticationOauthClientId": { - "description": "The OAuth client ID. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, + "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.", + "maxLength": 2048, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-default": "", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": false, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "authenticationKerberosKeytabFileName", + "authenticationKerberosUserPrincipalName" + ], + "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": true + }, + "authenticationKerberosKeytabFileName": { + "description": "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 2.40.", + "maxLength": 255, "minLength": 0, "type": "string", "x-accessLevels": { @@ -21767,7 +22796,6 @@ "enabled" ], "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", "x-default": "", "x-deprecated": false, "x-identifying": false, @@ -21777,12 +22805,17 @@ "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, + "x-requires": [ + "authenticationKerberosKeytabContent", + "authenticationKerberosUserPrincipalName" + ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, - "authenticationOauthClientScope": { - "description": "The OAuth scope. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, + "authenticationKerberosServiceName": { + "description": "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 2.40.", + "maxLength": 128, "minLength": 0, "type": "string", "x-accessLevels": { @@ -21804,6 +22837,92 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + }, + "authenticationKerberosUserPrincipalName": { + "description": "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 2.40.", + "maxLength": 642, + "minLength": 0, + "pattern": "^(.+@.+)?$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "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-requires": [ + "authenticationKerberosKeytabContent", + "authenticationKerberosKeytabFileName" + ], + "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + }, + "authenticationOauthClientId": { + "description": "The OAuth client ID. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 200, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "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. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 200, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "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 }, "authenticationOauthClientSecret": { @@ -21829,6 +22948,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationOauthClientTokenEndpoint": { @@ -21856,15 +22976,17 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationScheme": { - "description": "The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports.\n
\n", + "description": "The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports.\n\"kerberos\" - Kerberos Authentication.\n\"oauth-client\" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports.\n
\n", "enum": [ "none", "basic", "scram", "client-certificate", + "kerberos", "oauth-client" ], "type": "string", @@ -21887,6 +23009,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationScramHash": { @@ -21915,6 +23038,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationScramPassword": { @@ -21943,6 +23067,7 @@ "authenticationScramUsername" ], "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationScramUsername": { @@ -21969,6 +23094,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "batchDelay": { @@ -21996,6 +23122,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "batchMaxSize": { @@ -22023,13 +23150,14 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "bootstrapAddressList": { "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.\n\nThis corresponds to the Kafka consumer API `bootstrap.servers` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 1044, "minLength": 0, - "pattern": "^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", + "pattern": "^(((((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", @@ -22050,6 +23178,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -22072,6 +23201,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "groupId": { @@ -22098,6 +23228,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "groupKeepaliveInterval": { @@ -22125,6 +23256,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "groupKeepaliveTimeout": { @@ -22152,6 +23284,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "groupMembershipType": { @@ -22180,6 +23313,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "groupPartitionSchemeList": { @@ -22206,6 +23340,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "kafkaReceiverName": { @@ -22227,13 +23362,13 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "metadataTopicExcludeList": { - "description": "A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "A comma-separated list of POSIX.2 regular expressions. Commas within each regular expression must be escaped as double commas. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 1023, "minLength": 0, - "pattern": "^(((\\^.*|[a-zA-Z0-9\\._\\-]+),)*(\\^.*|[a-zA-Z0-9\\._\\-]+))?$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", @@ -22254,6 +23389,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "metadataTopicRefreshInterval": { @@ -22281,6 +23417,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -22302,6 +23439,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportTlsEnabled": { @@ -22326,6 +23464,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -22388,6 +23527,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "initialOffset": { @@ -22416,6 +23556,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "kafkaReceiverName": { @@ -22437,6 +23578,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "localKey": { @@ -22463,6 +23605,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "localTopic": { @@ -22489,6 +23632,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -22510,13 +23654,14 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicName": { - "description": "The name of the Topic.", + "description": "The name of the Topic or a POSIX.2 regular expression starting with '^'.", "maxLength": 255, "minLength": 1, - "pattern": "^\\^.*|[a-zA-Z0-9\\._\\-]+$", + "pattern": "^\\^.{0,254}|[a-zA-Z0-9\\._\\-]{1,255}$", "type": "string", "x-accessLevels": { "get": "vpn/read-only" @@ -22531,6 +23676,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -22641,6 +23787,7 @@ "authenticationBasicUsername" ], "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationBasicUsername": { @@ -22667,6 +23814,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertContent": { @@ -22691,6 +23839,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationClientCertPassword": { @@ -22718,48 +23867,21 @@ "authenticationClientCertContent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, - "authenticationOauthClientId": { - "description": "The OAuth client ID. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "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-writeOnly": false - }, - "authenticationOauthClientScope": { - "description": "The OAuth scope. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 200, + "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.", + "maxLength": 2048, "minLength": 0, "type": "string", "x-accessLevels": { - "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ "enabled" ], "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", "x-default": "", "x-deprecated": false, "x-identifying": false, @@ -22767,41 +23889,20 @@ "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "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 `\"\"`.", - "maxLength": 512, - "minLength": 0, - "type": "string", - "x-accessLevels": { - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", - "x-default": "", - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": true, - "x-readOnlyOther": false, - "x-readOnlyPost": false, "x-readOptional": true, "x-requiredPost": false, + "x-requires": [ + "authenticationKerberosKeytabFileName", + "authenticationKerberosUserPrincipalName" + ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, - "authenticationOauthClientTokenEndpoint": { - "description": "The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with \"https\". To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 2048, + "authenticationKerberosKeytabFileName": { + "description": "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 2.40.", + "maxLength": 255, "minLength": 0, - "pattern": "^([hH][tT][tT][pP][sS]://.+)?$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", @@ -22811,7 +23912,6 @@ "enabled" ], "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", "x-default": "", "x-deprecated": false, "x-identifying": false, @@ -22821,46 +23921,18 @@ "x-readOnlyPost": false, "x-readOptional": false, "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "authenticationScheme": { - "description": "The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports.\n
\n", - "enum": [ - "none", - "basic", - "scram", - "client-certificate", - "oauth-client" - ], - "type": "string", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" + "x-requires": [ + "authenticationKerberosKeytabContent", + "authenticationKerberosUserPrincipalName" ], - "x-configSyncDefault": "none", - "x-configSyncTableType": "vpn", - "x-default": "none", - "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 }, - "authenticationScramHash": { - "description": "The hash used for SCRAM authentication. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", - "enum": [ - "sha-256", - "sha-512" - ], + "authenticationKerberosServiceName": { + "description": "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 2.40.", + "maxLength": 128, + "minLength": 0, "type": "string", "x-accessLevels": { "get": "vpn/read-only", @@ -22869,9 +23941,9 @@ "x-autoDisable": [ "enabled" ], - "x-configSyncDefault": "sha-512", + "x-configSyncDefault": "", "x-configSyncTableType": "vpn", - "x-default": "sha-512", + "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, @@ -22881,39 +23953,43 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "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 `\"\"`.", - "maxLength": 255, + "authenticationKerberosUserPrincipalName": { + "description": "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 2.40.", + "maxLength": 642, "minLength": 0, + "pattern": "^(.+@.+)?$", "type": "string", "x-accessLevels": { + "get": "vpn/read-only", "patch": "vpn/read-write" }, "x-autoDisable": [ "enabled" ], "x-configSyncDefault": "", - "x-configSyncTableType": "vpn", "x-default": "", "x-deprecated": false, "x-identifying": false, "x-identifyingDirect": false, - "x-opaque": true, + "x-opaque": false, "x-readOnlyOther": false, "x-readOnlyPost": false, - "x-readOptional": true, + "x-readOptional": false, "x-requiredPost": false, "x-requires": [ - "authenticationScramUsername" + "authenticationKerberosKeytabContent", + "authenticationKerberosKeytabFileName" ], "x-requiresDisable": [], - "x-writeOnly": true + "x-sensitive": false, + "x-writeOnly": false }, - "authenticationScramUsername": { - "description": "The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 255, + "authenticationOauthClientId": { + "description": "The OAuth client ID. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 200, "minLength": 0, "type": "string", "x-accessLevels": { @@ -22935,94 +24011,13 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, - "batchDelay": { - "description": "Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `linger.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", - "format": "int32", - "maximum": 900000, - "minimum": 0, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 5, - "x-configSyncTableType": "vpn", - "x-default": 5, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "batchMaxMsgCount": { - "description": "Maximum number of messages sent in a single batch. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", - "format": "int32", - "maximum": 1000000, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 10000, - "x-configSyncTableType": "vpn", - "x-default": 10000, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "batchMaxSize": { - "description": "Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `batch.size` configuration setting, and should not exceed either the Kafka broker `message.max.bytes` configuration setting, or the per-Topic override of `max.message.bytes`.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", - "format": "int32", - "maximum": 2147483647, - "minimum": 1, - "type": "integer", - "x-accessLevels": { - "get": "vpn/read-only", - "patch": "vpn/read-write" - }, - "x-autoDisable": [ - "enabled" - ], - "x-configSyncDefault": 1000000, - "x-configSyncTableType": "vpn", - "x-default": 1000000, - "x-deprecated": false, - "x-identifying": false, - "x-identifyingDirect": false, - "x-opaque": false, - "x-readOnlyOther": false, - "x-readOnlyPost": false, - "x-readOptional": false, - "x-requiredPost": false, - "x-requiresDisable": [], - "x-writeOnly": false - }, - "bootstrapAddressList": { - "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.\n\nThis corresponds to the Kafka producer API `bootstrap.servers` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", - "maxLength": 1044, + "authenticationOauthClientScope": { + "description": "The OAuth scope. To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 200, "minLength": 0, - "pattern": "^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", "type": "string", "x-accessLevels": { "get": "vpn/read-only", @@ -23043,6 +24038,291 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, + "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 `\"\"`.", + "maxLength": 512, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-sensitive": true, + "x-writeOnly": true + }, + "authenticationOauthClientTokenEndpoint": { + "description": "The OAuth token endpoint URL that the Kafka Sender will use to request a token for login to the Kafka broker. Must begin with \"https\". To be used when authenticationScheme is \"oauth-client\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 2048, + "minLength": 0, + "pattern": "^([hH][tT][tT][pP][sS]://.+)?$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "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 + }, + "authenticationScheme": { + "description": "The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka Broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka Broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka Broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka Broker SSL listener ports.\n\"kerberos\" - Kerberos Authentication.\n\"oauth-client\" - Oauth Authentication. Used with Kafka Broker SASL_SSL listener ports.\n
\n", + "enum": [ + "none", + "basic", + "scram", + "client-certificate", + "kerberos", + "oauth-client" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "none", + "x-configSyncTableType": "vpn", + "x-default": "none", + "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 + }, + "authenticationScramHash": { + "description": "The hash used for SCRAM authentication. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"sha-512\"`. The allowed values and their meaning are:\n\n
\n\"sha-256\" - SHA-2 256 bits.\n\"sha-512\" - SHA-2 512 bits.\n
\n", + "enum": [ + "sha-256", + "sha-512" + ], + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "sha-512", + "x-configSyncTableType": "vpn", + "x-default": "sha-512", + "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 + }, + "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 `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": "", + "x-configSyncTableType": "vpn", + "x-default": "", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requires": [ + "authenticationScramUsername" + ], + "x-requiresDisable": [], + "x-sensitive": true, + "x-writeOnly": true + }, + "authenticationScramUsername": { + "description": "The username the Kafka Sender uses to login to the remote Kafka broker. To be used when authenticationScheme is \"scram\". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 255, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "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 + }, + "batchDelay": { + "description": "Delay (in ms) to wait to accumulate a batch of messages to send. Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `linger.ms` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `5`.", + "format": "int32", + "maximum": 900000, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": 5, + "x-configSyncTableType": "vpn", + "x-default": 5, + "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 + }, + "batchMaxMsgCount": { + "description": "Maximum number of messages sent in a single batch. Batching is done for all Senders on a per-partition basis. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10000`.", + "format": "int32", + "maximum": 1000000, + "minimum": 1, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": 10000, + "x-configSyncTableType": "vpn", + "x-default": 10000, + "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 + }, + "batchMaxSize": { + "description": "Maximum size of a message batch, in bytes (B). Batching is done for all Senders on a per-partition basis.\n\nThis corresponds to the Kafka producer API `batch.size` configuration setting, and should not exceed either the Kafka broker `message.max.bytes` configuration setting, or the per-Topic override of `max.message.bytes`.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000000`.", + "format": "int32", + "maximum": 2147483647, + "minimum": 1, + "type": "integer", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "x-configSyncDefault": 1000000, + "x-configSyncTableType": "vpn", + "x-default": 1000000, + "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 + }, + "bootstrapAddressList": { + "description": "Comma separated list of addresses (and optional ports) of brokers in the Kafka Cluster from which the state of the entire Kafka Cluster can be learned. If a port is not provided with an address it will default to 9092.\n\nThis corresponds to the Kafka producer API `bootstrap.servers` configuration setting.\n\nModifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "maxLength": 1044, + "minLength": 0, + "pattern": "^(((((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$", + "type": "string", + "x-accessLevels": { + "get": "vpn/read-only", + "patch": "vpn/read-write" + }, + "x-autoDisable": [ + "enabled" + ], + "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 }, "enabled": { @@ -23065,6 +24345,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "idempotenceEnabled": { @@ -23089,6 +24370,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "kafkaSenderName": { @@ -23110,6 +24392,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -23131,6 +24414,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportCompressionEnabled": { @@ -23155,6 +24439,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportCompressionLevel": { @@ -23182,6 +24467,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportCompressionType": { @@ -23212,6 +24498,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "transportTlsEnabled": { @@ -23236,6 +24523,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -23288,6 +24576,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -23310,6 +24599,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "kafkaSenderName": { @@ -23331,6 +24621,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -23352,6 +24643,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "partitionConsistentHash": { @@ -23381,6 +24673,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "partitionExplicitNumber": { @@ -23408,6 +24701,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "partitionRandomFallbackEnabled": { @@ -23432,6 +24726,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "partitionScheme": { @@ -23461,6 +24756,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueName": { @@ -23482,6 +24778,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteKey": { @@ -23508,6 +24805,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteTopic": { @@ -23535,6 +24833,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -23640,6 +24939,10 @@ "description": "The URI of this Message VPN's collection of ACL Profile objects.", "type": "string" }, + "authenticationKerberosRealmsUri": { + "description": "The URI of this Message VPN's collection of Realm objects. Available since 2.40.", + "type": "string" + }, "authenticationOauthProfilesUri": { "description": "The URI of this Message VPN's collection of OAuth Profile objects. Available since 2.25.", "type": "string" @@ -23772,6 +25075,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -23794,6 +25098,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgLifetime": { @@ -23819,6 +25124,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -23840,6 +25146,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -23921,6 +25228,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "mqttSessionClientId": { @@ -23941,6 +25249,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "mqttSessionVirtualRouter": { @@ -23964,6 +25273,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -23985,6 +25295,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "owner": { @@ -24011,6 +25322,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueConsumerAckPropagationEnabled": { @@ -24033,6 +25345,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueDeadMsgQueue": { @@ -24058,6 +25371,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueEventBindCountThreshold": { @@ -24092,6 +25406,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxDeliveredUnackedMsgsPerFlow": { @@ -24117,6 +25432,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxMsgSize": { @@ -24142,6 +25458,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxMsgSpoolUsage": { @@ -24167,6 +25484,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxRedeliveryCount": { @@ -24192,6 +25510,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxTtl": { @@ -24217,6 +25536,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueRejectLowPriorityMsgEnabled": { @@ -24239,6 +25559,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueRejectLowPriorityMsgLimit": { @@ -24264,6 +25585,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueRejectMsgToSenderOnDiscardBehavior": { @@ -24293,6 +25615,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueRespectTtlEnabled": { @@ -24315,6 +25638,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -24371,6 +25695,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -24401,6 +25726,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -24433,6 +25759,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -24463,6 +25790,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -24501,6 +25829,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -24531,6 +25860,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -24563,6 +25893,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -24593,6 +25924,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -24631,6 +25963,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -24661,6 +25994,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -24693,6 +26027,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -24723,6 +26058,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -24765,6 +26101,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "mqttSessionVirtualRouter": { @@ -24788,6 +26125,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -24809,6 +26147,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscriptionQos": { @@ -24834,6 +26173,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscriptionTopic": { @@ -24854,6 +26194,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -24982,6 +26323,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationBasicUsername": { @@ -25006,6 +26348,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationScheme": { @@ -25032,6 +26375,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -25054,6 +26398,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "host": { @@ -25079,6 +26424,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -25100,6 +26446,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "port": { @@ -25125,6 +26472,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "proxyName": { @@ -25146,6 +26494,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "proxyType": { @@ -25172,6 +26521,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -25236,6 +26586,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "consumerAckPropagationEnabled": { @@ -25258,6 +26609,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deadMsgQueue": { @@ -25283,6 +26635,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliveryCountEnabled": { @@ -25305,6 +26658,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliveryDelay": { @@ -25330,6 +26684,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "egressEnabled": { @@ -25352,6 +26707,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventBindCountThreshold": { @@ -25383,6 +26739,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxBindCount": { @@ -25408,6 +26765,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxDeliveredUnackedMsgsPerFlow": { @@ -25433,6 +26791,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSize": { @@ -25458,6 +26817,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSpoolUsage": { @@ -25483,6 +26843,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxRedeliveryCount": { @@ -25508,6 +26869,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTtl": { @@ -25533,6 +26895,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -25554,6 +26917,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "owner": { @@ -25580,6 +26944,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "partitionCount": { @@ -25605,6 +26970,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "partitionRebalanceDelay": { @@ -25630,6 +26996,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "partitionRebalanceMaxHandoffTime": { @@ -25655,6 +27022,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "permission": { @@ -25686,6 +27054,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueName": { @@ -25707,6 +27076,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayEnabled": { @@ -25731,6 +27101,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayInitialInterval": { @@ -25758,6 +27129,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMaxInterval": { @@ -25785,6 +27157,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMultiplier": { @@ -25812,6 +27185,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryEnabled": { @@ -25834,6 +27208,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgEnabled": { @@ -25856,6 +27231,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgLimit": { @@ -25881,6 +27257,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectMsgToSenderOnDiscardBehavior": { @@ -25910,6 +27287,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectMsgPriorityEnabled": { @@ -25935,6 +27313,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectTtlEnabled": { @@ -25957,6 +27336,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -26000,6 +27380,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -26030,6 +27411,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -26062,6 +27444,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -26092,6 +27475,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -26130,6 +27514,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -26160,6 +27545,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -26192,6 +27578,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -26222,6 +27609,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -26260,6 +27648,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -26290,6 +27679,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -26322,6 +27712,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -26352,6 +27743,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -26408,6 +27800,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueName": { @@ -26429,6 +27822,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscriptionTopic": { @@ -26449,6 +27843,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -26534,6 +27929,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "consumerAckPropagationEnabled": { @@ -26556,6 +27952,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deadMsgQueue": { @@ -26581,6 +27978,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliveryDelay": { @@ -26606,6 +28004,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "durabilityOverride": { @@ -26632,6 +28031,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventBindCountThreshold": { @@ -26666,6 +28066,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxDeliveredUnackedMsgsPerFlow": { @@ -26691,6 +28092,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSize": { @@ -26716,6 +28118,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSpoolUsage": { @@ -26741,6 +28144,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxRedeliveryCount": { @@ -26766,6 +28170,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTtl": { @@ -26791,6 +28196,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -26812,6 +28218,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "permission": { @@ -26841,10 +28248,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueNameFilter": { - "description": "A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 200, "minLength": 0, "type": "string", @@ -26865,6 +28273,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueTemplateName": { @@ -26886,6 +28295,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayEnabled": { @@ -26908,6 +28318,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayInitialInterval": { @@ -26933,6 +28344,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMaxInterval": { @@ -26958,6 +28370,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMultiplier": { @@ -26983,6 +28396,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryEnabled": { @@ -27005,6 +28419,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgEnabled": { @@ -27027,6 +28442,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgLimit": { @@ -27052,6 +28468,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectMsgToSenderOnDiscardBehavior": { @@ -27079,6 +28496,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectMsgPriorityEnabled": { @@ -27101,6 +28519,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectTtlEnabled": { @@ -27123,6 +28542,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -27166,6 +28586,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -27196,6 +28617,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -27228,6 +28650,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -27258,6 +28681,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -27296,6 +28720,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -27326,6 +28751,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -27358,6 +28784,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -27388,6 +28815,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -27426,6 +28854,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -27456,6 +28885,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -27488,6 +28918,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -27518,6 +28949,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -27617,6 +29049,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "ingressEnabled": { @@ -27639,6 +29072,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxSpoolUsage": { @@ -27664,6 +29098,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -27685,6 +29120,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replayLogName": { @@ -27706,6 +29142,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicFilterEnabled": { @@ -27728,6 +29165,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -27789,6 +29227,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replayLogName": { @@ -27810,6 +29249,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicFilterSubscription": { @@ -27830,6 +29270,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -27933,6 +29374,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicatedTopic": { @@ -27953,6 +29395,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "replicationMode": { @@ -27979,6 +29422,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -28082,6 +29526,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -28104,6 +29549,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -28125,6 +29571,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restDeliveryPointName": { @@ -28145,6 +29592,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "service": { @@ -28169,6 +29617,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "vendor": { @@ -28193,6 +29642,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -28242,6 +29692,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -28263,6 +29714,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "postRequestTarget": { @@ -28287,6 +29739,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueBindingName": { @@ -28308,6 +29761,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "requestTargetEvaluation": { @@ -28334,6 +29788,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restDeliveryPointName": { @@ -28354,6 +29809,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -28402,6 +29858,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "headerValue": { @@ -28425,6 +29882,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "msgVpnName": { @@ -28446,6 +29904,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueBindingName": { @@ -28467,6 +29926,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restDeliveryPointName": { @@ -28487,6 +29947,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -28567,6 +30028,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "headerValue": { @@ -28591,6 +30053,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -28612,6 +30075,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueBindingName": { @@ -28633,6 +30097,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restDeliveryPointName": { @@ -28653,6 +30118,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -28793,6 +30259,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationAwsRegion": { @@ -28817,6 +30284,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationAwsSecretAccessKey": { @@ -28840,6 +30308,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationAwsService": { @@ -28864,6 +30333,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationClientCertContent": { @@ -28888,6 +30358,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationClientCertPassword": { @@ -28915,6 +30386,7 @@ "authenticationClientCertContent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": true }, "authenticationHttpBasicPassword": { @@ -28943,6 +30415,7 @@ "authenticationHttpBasicUsername" ], "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationHttpBasicUsername": { @@ -28972,6 +30445,7 @@ "authenticationHttpBasicPassword" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationHttpHeaderName": { @@ -28997,6 +30471,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationHttpHeaderValue": { @@ -29021,6 +30496,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationOauthClientId": { @@ -29047,6 +30523,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthClientScope": { @@ -29073,6 +30550,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthClientSecret": { @@ -29098,6 +30576,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationOauthClientTokenEndpoint": { @@ -29124,6 +30603,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthClientTokenExpiryDefault": { @@ -29151,6 +30631,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthJwtSecretKey": { @@ -29176,6 +30657,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "authenticationOauthJwtTokenEndpoint": { @@ -29202,6 +30684,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationOauthJwtTokenExpiryDefault": { @@ -29229,6 +30712,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authenticationScheme": { @@ -29263,6 +30747,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -29285,6 +30770,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "httpMethod": { @@ -29311,6 +30797,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "localInterface": { @@ -29335,6 +30822,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxPostWaitTime": { @@ -29360,6 +30848,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -29381,6 +30870,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "outgoingConnectionCount": { @@ -29408,6 +30898,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "proxyName": { @@ -29432,6 +30923,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remoteHost": { @@ -29459,6 +30951,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "remotePort": { @@ -29489,6 +30982,7 @@ "tlsEnabled" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restConsumerName": { @@ -29509,6 +31003,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restDeliveryPointName": { @@ -29529,6 +31024,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "retryDelay": { @@ -29554,6 +31050,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsCipherSuiteList": { @@ -29580,6 +31077,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsEnabled": { @@ -29607,6 +31105,7 @@ "remotePort" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -29655,6 +31154,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthJwtClaimName": { @@ -29675,6 +31175,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthJwtClaimValue": { @@ -29695,6 +31196,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restConsumerName": { @@ -29715,6 +31217,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restDeliveryPointName": { @@ -29735,6 +31238,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -29832,6 +31336,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restConsumerName": { @@ -29852,6 +31357,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "restDeliveryPointName": { @@ -29872,6 +31378,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "tlsTrustedCommonName": { @@ -29892,6 +31399,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -30018,6 +31526,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sequencedTopic": { @@ -30038,6 +31547,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -30118,6 +31628,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueEventBindCountThreshold": { @@ -30149,6 +31660,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "queueMaxMsgSpoolUsage": { @@ -30174,6 +31686,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverAclConnectDefaultAction": { @@ -30200,6 +31713,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverEnabled": { @@ -30222,6 +31736,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverEventConnectionCountPerClientUsernameThreshold": { @@ -30248,6 +31763,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverTcpCongestionWindowSize": { @@ -30273,6 +31789,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverTcpKeepaliveCount": { @@ -30298,6 +31815,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverTcpKeepaliveIdleTime": { @@ -30323,6 +31841,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverTcpKeepaliveInterval": { @@ -30348,6 +31867,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverTcpMaxSegmentSize": { @@ -30373,6 +31893,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverTcpMaxWindowSize": { @@ -30398,6 +31919,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "telemetryProfileName": { @@ -30419,6 +31941,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "traceEnabled": { @@ -30441,6 +31964,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "traceSendSpanGenerationEnabled": { @@ -30463,6 +31987,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -30523,6 +32048,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -30553,6 +32079,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -30585,6 +32112,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -30615,6 +32143,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -30653,6 +32182,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -30683,6 +32213,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -30715,6 +32246,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -30745,6 +32277,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -30771,6 +32304,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "receiverAclConnectExceptionAddress": { @@ -30792,6 +32326,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "telemetryProfileName": { @@ -30813,6 +32348,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -30905,6 +32441,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -30935,6 +32472,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -30967,6 +32505,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -30997,6 +32536,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -31041,6 +32581,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -31062,6 +32603,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "telemetryProfileName": { @@ -31083,6 +32625,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "traceFilterName": { @@ -31104,6 +32647,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -31165,6 +32709,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscription": { @@ -31185,6 +32730,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "subscriptionSyntax": { @@ -31207,6 +32753,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "telemetryProfileName": { @@ -31228,6 +32775,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "traceFilterName": { @@ -31249,6 +32797,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -31382,6 +32931,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "consumerAckPropagationEnabled": { @@ -31404,6 +32954,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deadMsgQueue": { @@ -31429,6 +32980,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliveryCountEnabled": { @@ -31451,6 +33003,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliveryDelay": { @@ -31476,6 +33029,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "egressEnabled": { @@ -31498,6 +33052,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventBindCountThreshold": { @@ -31529,6 +33084,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxBindCount": { @@ -31554,6 +33110,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxDeliveredUnackedMsgsPerFlow": { @@ -31579,6 +33136,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSize": { @@ -31604,6 +33162,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxRedeliveryCount": { @@ -31629,6 +33188,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxSpoolUsage": { @@ -31654,6 +33214,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTtl": { @@ -31679,6 +33240,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -31700,6 +33262,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "owner": { @@ -31726,6 +33289,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "permission": { @@ -31757,6 +33321,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayEnabled": { @@ -31781,6 +33346,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayInitialInterval": { @@ -31808,6 +33374,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMaxInterval": { @@ -31835,6 +33402,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMultiplier": { @@ -31862,6 +33430,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryEnabled": { @@ -31884,6 +33453,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgEnabled": { @@ -31906,6 +33476,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgLimit": { @@ -31931,6 +33502,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectMsgToSenderOnDiscardBehavior": { @@ -31960,6 +33532,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectMsgPriorityEnabled": { @@ -31985,6 +33558,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectTtlEnabled": { @@ -32007,6 +33581,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicEndpointName": { @@ -32028,6 +33603,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -32071,6 +33647,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -32101,6 +33678,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -32133,6 +33711,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -32163,6 +33742,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -32201,6 +33781,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -32231,6 +33812,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -32263,6 +33845,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -32293,6 +33876,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -32331,6 +33915,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -32361,6 +33946,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -32393,6 +33979,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -32423,6 +34010,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -32480,6 +34068,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "consumerAckPropagationEnabled": { @@ -32502,6 +34091,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deadMsgQueue": { @@ -32527,6 +34117,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "deliveryDelay": { @@ -32552,6 +34143,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "eventBindCountThreshold": { @@ -32586,6 +34178,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxDeliveredUnackedMsgsPerFlow": { @@ -32611,6 +34204,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSize": { @@ -32636,6 +34230,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxMsgSpoolUsage": { @@ -32661,6 +34256,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxRedeliveryCount": { @@ -32686,6 +34282,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "maxTtl": { @@ -32711,6 +34308,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -32732,6 +34330,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "permission": { @@ -32761,6 +34360,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayEnabled": { @@ -32783,6 +34383,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayInitialInterval": { @@ -32808,6 +34409,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMaxInterval": { @@ -32833,6 +34435,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryDelayMultiplier": { @@ -32858,6 +34461,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "redeliveryEnabled": { @@ -32880,6 +34484,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgEnabled": { @@ -32902,6 +34507,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectLowPriorityMsgLimit": { @@ -32927,6 +34533,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "rejectMsgToSenderOnDiscardBehavior": { @@ -32954,6 +34561,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectMsgPriorityEnabled": { @@ -32976,6 +34584,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "respectTtlEnabled": { @@ -32998,10 +34607,11 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicEndpointNameFilter": { - "description": "A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + "description": "A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", "maxLength": 200, "minLength": 0, "type": "string", @@ -33022,6 +34632,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "topicEndpointTemplateName": { @@ -33043,6 +34654,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -33086,6 +34698,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -33116,6 +34729,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -33148,6 +34762,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -33178,6 +34793,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -33216,6 +34832,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -33246,6 +34863,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -33278,6 +34896,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -33308,6 +34927,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -33346,6 +34966,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -33376,6 +34997,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -33408,6 +35030,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -33438,6 +35061,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -33562,6 +35186,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "accessLevelGroupsClaimStringFormat": { @@ -33588,6 +35213,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientId": { @@ -33612,6 +35238,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientRedirectUri": { @@ -33636,6 +35263,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientRequiredType": { @@ -33660,6 +35288,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientScope": { @@ -33684,6 +35313,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientSecret": { @@ -33707,6 +35337,7 @@ "x-readOptional": true, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": true, "x-writeOnly": true }, "clientValidateTypeEnabled": { @@ -33729,6 +35360,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "defaultGlobalAccessLevel": { @@ -33757,6 +35389,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "defaultMsgVpnAccessLevel": { @@ -33784,6 +35417,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "displayName": { @@ -33808,6 +35442,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "enabled": { @@ -33830,6 +35465,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointAuthorization": { @@ -33854,6 +35490,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointDiscovery": { @@ -33878,6 +35515,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointDiscoveryRefreshInterval": { @@ -33903,6 +35541,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointIntrospection": { @@ -33927,6 +35566,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointIntrospectionTimeout": { @@ -33952,6 +35592,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointJwks": { @@ -33976,6 +35617,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointJwksRefreshInterval": { @@ -34001,6 +35643,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointToken": { @@ -34025,6 +35668,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointTokenTimeout": { @@ -34050,6 +35694,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointUserinfo": { @@ -34074,6 +35719,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "endpointUserinfoTimeout": { @@ -34099,6 +35745,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "interactiveEnabled": { @@ -34121,6 +35768,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "interactivePromptForExpiredSession": { @@ -34145,6 +35793,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "interactivePromptForNewSession": { @@ -34169,6 +35818,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "issuer": { @@ -34193,6 +35843,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -34214,6 +35865,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthRole": { @@ -34240,6 +35892,32 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + }, + "proxyName": { + "description": "The name of the proxy to use for discovery, user info, jwks, and introspection requests. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.41.", + "maxLength": 32, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "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 }, "resourceServerParseAccessTokenEnabled": { @@ -34262,6 +35940,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredAudience": { @@ -34286,6 +35965,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredIssuer": { @@ -34310,6 +35990,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredScope": { @@ -34334,6 +36015,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredType": { @@ -34358,6 +36040,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateAudienceEnabled": { @@ -34380,6 +36063,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateIssuerEnabled": { @@ -34402,6 +36086,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateScopeEnabled": { @@ -34424,6 +36109,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerValidateTypeEnabled": { @@ -34446,6 +36132,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempEnabled": { @@ -34468,6 +36155,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "usernameClaimName": { @@ -34492,6 +36180,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -34526,6 +36215,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "globalAccessLevel": { @@ -34554,6 +36244,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "groupName": { @@ -34574,6 +36265,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnAccessLevel": { @@ -34601,6 +36293,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -34622,6 +36315,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -34672,6 +36366,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "groupName": { @@ -34692,6 +36387,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -34713,6 +36409,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -34734,6 +36431,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -34853,6 +36551,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -34874,6 +36573,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -34953,6 +36653,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "authorizationParameterValue": { @@ -34977,6 +36678,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -34998,6 +36700,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -35077,6 +36780,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clientRequiredClaimValue": { @@ -35097,6 +36801,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -35118,6 +36823,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -35204,6 +36910,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -35225,6 +36932,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "oauthProfileName": { @@ -35246,6 +36954,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -35359,6 +37068,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredClaimName": { @@ -35379,6 +37089,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "resourceServerRequiredClaimValue": { @@ -35399,6 +37110,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -35498,6 +37210,265 @@ ], "type": "object" }, + "ProxiesResponse": { + "properties": { + "data": { + "items": { + "$ref": "#/definitions/Proxy" + }, + "type": "array" + }, + "links": { + "items": { + "$ref": "#/definitions/ProxyLinks" + }, + "type": "array" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, + "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 `\"\"`.", + "maxLength": 64, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "x-default": "", + "x-deprecated": false, + "x-identifying": false, + "x-identifyingDirect": false, + "x-opaque": true, + "x-readOnlyOther": false, + "x-readOnlyPost": false, + "x-readOptional": true, + "x-requiredPost": false, + "x-requiresDisable": [], + "x-sensitive": true, + "x-writeOnly": true + }, + "authenticationBasicUsername": { + "description": "The username to use with basic authentication. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 32, + "minLength": 0, + "type": "string", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "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 + }, + "authenticationScheme": { + "description": "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:\n\n
\n\"none\" - No authentication.\n\"basic\" - Username/password authentication.\n
\n", + "enum": [ + "none", + "basic" + ], + "type": "string", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": "none", + "x-configSyncTableType": "router", + "x-default": "none", + "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 + }, + "enabled": { + "description": "Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + "type": "boolean", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": false, + "x-configSyncTableType": "router", + "x-default": false, + "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 + }, + "host": { + "description": "The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + "maxLength": 253, + "minLength": 0, + "pattern": "^([0-9a-zA-Z\\-\\.]*|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,7}:|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|:((:[0-9a-fA-F]{1,4}){1,7}|:)|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])$", + "type": "string", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": "", + "x-configSyncTableType": "router", + "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 + }, + "port": { + "description": "The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.", + "format": "int32", + "maximum": 65535, + "minimum": 0, + "type": "integer", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": 0, + "x-configSyncTableType": "router", + "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 + }, + "proxyName": { + "description": "The name of the proxy.", + "maxLength": 32, + "minLength": 1, + "pattern": "^[^#*? ]([^*?]*[^*? ])?$", + "type": "string", + "x-accessLevels": { + "get": "global/read-only" + }, + "x-autoDisable": [], + "x-deprecated": false, + "x-identifying": true, + "x-identifyingDirect": true, + "x-opaque": false, + "x-readOnlyOther": true, + "x-readOnlyPost": false, + "x-readOptional": false, + "x-requiredPost": true, + "x-requiresDisable": [], + "x-sensitive": false, + "x-writeOnly": false + }, + "proxyType": { + "description": "The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"direct\"`. The allowed values and their meaning are:\n\n
\n\"direct\" - Direct connection (no proxy).\n\"http\" - HTTP proxy.\n
\n", + "enum": [ + "direct", + "http" + ], + "type": "string", + "x-accessLevels": { + "get": "global/read-only", + "patch": "global/admin" + }, + "x-autoDisable": [], + "x-configSyncDefault": "direct", + "x-configSyncTableType": "router", + "x-default": "direct", + "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 + } + }, + "type": "object", + "x-accessLevels": { + "delete": "global/admin", + "post": "global/admin" + }, + "x-configSyncTableTypeCreateDelete": "router" + }, + "ProxyLinks": { + "properties": { + "uri": { + "description": "The URI of this Proxy object.", + "type": "string" + } + }, + "type": "object" + }, + "ProxyResponse": { + "properties": { + "data": { + "$ref": "#/definitions/Proxy" + }, + "links": { + "$ref": "#/definitions/ProxyLinks" + }, + "meta": { + "$ref": "#/definitions/SempMeta" + } + }, + "required": [ + "meta" + ], + "type": "object" + }, "SempError": { "properties": { "code": { @@ -35626,6 +37597,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -35656,6 +37628,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -35688,6 +37661,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -35718,6 +37692,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -35756,6 +37731,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -35786,6 +37762,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -35818,6 +37795,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -35848,6 +37826,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -35886,6 +37865,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -35916,6 +37896,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -35948,6 +37929,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -35978,6 +37960,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -36016,6 +37999,7 @@ "setPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "clearValue": { @@ -36046,6 +38030,7 @@ "setValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setPercent": { @@ -36078,6 +38063,7 @@ "clearPercent" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "setValue": { @@ -36108,6 +38094,7 @@ "clearValue" ], "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -36133,6 +38120,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "sempVersion": { @@ -36153,6 +38141,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -36206,6 +38195,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "msgVpnName": { @@ -36231,6 +38221,7 @@ "x-readOptional": false, "x-requiredPost": false, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false }, "virtualHostname": { @@ -36251,6 +38242,7 @@ "x-readOptional": false, "x-requiredPost": true, "x-requiresDisable": [], + "x-sensitive": false, "x-writeOnly": false } }, @@ -36320,7 +38312,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.39" + "version": "2.41" }, "parameters": { "countQuery": { @@ -36387,7 +38379,7 @@ "paths": { "/": { "get": { - "description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Opaque\n:---|:---:|:---:\ntlsServerCertContent|x|x\ntlsServerCertPassword|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthClientCertRevocationCheckMode|global/read-only\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-only\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-only\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-only\nconfigSyncClientProfileTcpKeepaliveCount|global/read-only\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-only\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-only\nconfigSyncClientProfileTcpMaxWindow|global/read-only\nconfigSyncClientProfileTcpMss|global/read-only\nconfigSyncEnabled|global/read-only\nconfigSyncSynchronizeUsernameEnabled|global/read-only\nconfigSyncTlsEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleDayList|global/read-only\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-only\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-only\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-only\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only\nguaranteedMsgingEnabled|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only\nguaranteedMsgingMaxCacheUsage|global/read-only\nguaranteedMsgingMaxMsgSpoolUsage|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only\noauthProfileDefault|global/read-only\nserviceAmqpEnabled|global/read-only\nserviceAmqpTlsListenPort|global/read-only\nserviceEventConnectionCountThreshold.clearPercent|global/read-only\nserviceEventConnectionCountThreshold.clearValue|global/read-only\nserviceEventConnectionCountThreshold.setPercent|global/read-only\nserviceEventConnectionCountThreshold.setValue|global/read-only\nserviceHealthCheckEnabled|global/read-only\nserviceHealthCheckListenPort|global/read-only\nserviceHealthCheckTlsEnabled|global/read-only\nserviceHealthCheckTlsListenPort|global/read-only\nserviceMateLinkEnabled|global/read-only\nserviceMateLinkListenPort|global/read-only\nserviceMqttEnabled|global/read-only\nserviceMsgBackboneEnabled|global/read-only\nserviceRedundancyEnabled|global/read-only\nserviceRedundancyFirstListenPort|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only\nserviceRestIncomingEnabled|global/read-only\nserviceRestOutgoingEnabled|global/read-only\nserviceSempCorsAllowAnyHostEnabled|global/read-only\nserviceSempLegacyTimeoutEnabled|global/read-only\nserviceSempPlainTextEnabled|global/read-only\nserviceSempPlainTextListenPort|global/read-only\nserviceSempSessionIdleTimeout|global/read-only\nserviceSempSessionMaxLifetime|global/read-only\nserviceSempTlsEnabled|global/read-only\nserviceSempTlsListenPort|global/read-only\nserviceSmfCompressionListenPort|global/read-only\nserviceSmfEnabled|global/read-only\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-only\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.setValue|global/read-only\nserviceSmfPlainTextListenPort|global/read-only\nserviceSmfRoutingControlListenPort|global/read-only\nserviceSmfTlsListenPort|global/read-only\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-only\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.setValue|global/read-only\nserviceWebTransportEnabled|global/read-only\nserviceWebTransportPlainTextListenPort|global/read-only\nserviceWebTransportTlsListenPort|global/read-only\nserviceWebTransportWebUrlSuffix|global/read-only\ntlsBlockVersion11Enabled|global/read-only\ntlsCipherSuiteManagementList|global/read-only\ntlsCipherSuiteMsgBackboneList|global/read-only\ntlsCipherSuiteSecureShellList|global/read-only\ntlsCrimeExploitProtectionEnabled|global/read-only\ntlsServerCertContent|global/read-only\ntlsTicketLifetime|global/read-only\n\n\n\nThis has been available since 2.13.", + "description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Opaque\n:---|:---:|:---:\ntlsServerCertContent|x|x\ntlsServerCertPassword|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauthBruteForceProtectionEnabled|global/read-only\nauthClientCertRevocationCheckMode|global/read-only\nconfigSyncAuthenticationClientCertMaxChainDepth|global/read-only\nconfigSyncAuthenticationClientCertValidateDateEnabled|global/read-only\nconfigSyncClientProfileTcpInitialCongestionWindow|global/read-only\nconfigSyncClientProfileTcpKeepaliveCount|global/read-only\nconfigSyncClientProfileTcpKeepaliveIdle|global/read-only\nconfigSyncClientProfileTcpKeepaliveInterval|global/read-only\nconfigSyncClientProfileTcpMaxWindow|global/read-only\nconfigSyncClientProfileTcpMss|global/read-only\nconfigSyncEnabled|global/read-only\nconfigSyncSynchronizeUsernameEnabled|global/read-only\nconfigSyncTlsEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleDayList|global/read-only\nguaranteedMsgingDefragmentationScheduleEnabled|global/read-only\nguaranteedMsgingDefragmentationScheduleTimeList|global/read-only\nguaranteedMsgingDefragmentationThresholdEnabled|global/read-only\nguaranteedMsgingDefragmentationThresholdFragmentationPercentage|global/read-only\nguaranteedMsgingDefragmentationThresholdMinInterval|global/read-only\nguaranteedMsgingDefragmentationThresholdUsagePercentage|global/read-only\nguaranteedMsgingEnabled|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventCacheUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDeliveredUnackedThreshold.setPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventDiskUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEgressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventEndpointCountThreshold.setValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventIngressFlowCountThreshold.setValue|global/read-only\nguaranteedMsgingEventMsgCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolFileCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.clearValue|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setPercent|global/read-only\nguaranteedMsgingEventMsgSpoolUsageThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactedSessionCountThreshold.setValue|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactedSessionResourceCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.clearValue|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setPercent|global/read-only\nguaranteedMsgingEventTransactionCountThreshold.setValue|global/read-only\nguaranteedMsgingMaxCacheUsage|global/read-only\nguaranteedMsgingMaxMsgSpoolUsage|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout|global/read-only\nguaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout|global/read-only\nguaranteedMsgingTransactionReplicationCompatibilityMode|global/read-only\noauthProfileDefault|global/read-only\nserviceAmqpEnabled|global/read-only\nserviceAmqpTlsListenPort|global/read-only\nserviceEventConnectionCountThreshold.clearPercent|global/read-only\nserviceEventConnectionCountThreshold.clearValue|global/read-only\nserviceEventConnectionCountThreshold.setPercent|global/read-only\nserviceEventConnectionCountThreshold.setValue|global/read-only\nserviceHealthCheckEnabled|global/read-only\nserviceHealthCheckListenPort|global/read-only\nserviceHealthCheckTlsEnabled|global/read-only\nserviceHealthCheckTlsListenPort|global/read-only\nserviceMateLinkEnabled|global/read-only\nserviceMateLinkListenPort|global/read-only\nserviceMqttEnabled|global/read-only\nserviceMsgBackboneEnabled|global/read-only\nserviceRedundancyEnabled|global/read-only\nserviceRedundancyFirstListenPort|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.clearValue|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setPercent|global/read-only\nserviceRestEventOutgoingConnectionCountThreshold.setValue|global/read-only\nserviceRestIncomingEnabled|global/read-only\nserviceRestOutgoingEnabled|global/read-only\nserviceSempCorsAllowAnyHostEnabled|global/read-only\nserviceSempLegacyTimeoutEnabled|global/read-only\nserviceSempPlainTextEnabled|global/read-only\nserviceSempPlainTextListenPort|global/read-only\nserviceSempSessionIdleTimeout|global/read-only\nserviceSempSessionMaxLifetime|global/read-only\nserviceSempTlsEnabled|global/read-only\nserviceSempTlsListenPort|global/read-only\nserviceSmfCompressionListenPort|global/read-only\nserviceSmfEnabled|global/read-only\nserviceSmfEventConnectionCountThreshold.clearPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.clearValue|global/read-only\nserviceSmfEventConnectionCountThreshold.setPercent|global/read-only\nserviceSmfEventConnectionCountThreshold.setValue|global/read-only\nserviceSmfPlainTextListenPort|global/read-only\nserviceSmfRoutingControlListenPort|global/read-only\nserviceSmfTlsListenPort|global/read-only\nserviceTlsEventConnectionCountThreshold.clearPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.clearValue|global/read-only\nserviceTlsEventConnectionCountThreshold.setPercent|global/read-only\nserviceTlsEventConnectionCountThreshold.setValue|global/read-only\nserviceWebTransportEnabled|global/read-only\nserviceWebTransportPlainTextListenPort|global/read-only\nserviceWebTransportTlsListenPort|global/read-only\nserviceWebTransportWebUrlSuffix|global/read-only\ntlsBlockVersion11Enabled|global/read-only\ntlsCipherSuiteManagementList|global/read-only\ntlsCipherSuiteMsgBackboneList|global/read-only\ntlsCipherSuiteSecureShellList|global/read-only\ntlsCrimeExploitProtectionEnabled|global/read-only\ntlsServerCertContent|global/read-only\ntlsTicketLifetime|global/read-only\n\n\n\nThis has been available since 2.13.", "operationId": "getBroker", "parameters": [ { @@ -36429,7 +38421,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:---|:---:\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/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.", "operationId": "updateBroker", "parameters": [ { @@ -43017,10 +45009,10 @@ "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles": { + "/msgVpns/{msgVpnName}/authenticationKerberosRealms": { "get": { - "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfiles", + "description": "Get a list of Realm objects.\n\nKerberos Realm.\n\n\nAttribute|Identifying\n:---|:---:\nkerberosRealmName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.40.", + "operationId": "getMsgVpnAuthenticationKerberosRealms", "parameters": [ { "description": "The name of the Message VPN.", @@ -43056,9 +45048,9 @@ ], "responses": { "200": { - "description": "The list of OAuth Profile objects' attributes, and the request metadata.", + "description": "The list of Realm objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfilesResponse" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealmsResponse" } }, "default": { @@ -43073,17 +45065,17 @@ "basicAuth": [] } ], - "summary": "Get a list of OAuth Profile objects.", + "summary": "Get a list of Realm objects.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "authenticationKerberosRealm" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "post": { - "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret|||||x|x\nmsgVpnName|x|||x||\noauthProfileName|x|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "createMsgVpnAuthenticationOauthProfile", + "description": "Create a Realm 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\nKerberos Realm.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nkerberosRealmName|x|x|x|\nmsgVpnName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.40.", + "operationId": "createMsgVpnAuthenticationKerberosRealm", "parameters": [ { "description": "The name of the Message VPN.", @@ -43093,12 +45085,12 @@ "type": "string" }, { - "description": "The OAuth Profile object's attributes.", + "description": "The Realm object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealm" } }, { @@ -43116,9 +45108,9 @@ ], "responses": { "200": { - "description": "The OAuth Profile object's attributes after being created, and the request metadata.", + "description": "The Realm object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealmResponse" } }, "default": { @@ -43133,19 +45125,19 @@ "basicAuth": [] } ], - "summary": "Create an OAuth Profile object.", + "summary": "Create a Realm object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "authenticationKerberosRealm" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}": { + "/msgVpns/{msgVpnName}/authenticationKerberosRealms/{kerberosRealmName}": { "delete": { - "description": "Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\nA SEMP client 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": "deleteMsgVpnAuthenticationOauthProfile", + "description": "Delete a Realm object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nKerberos Realm.\n\nA SEMP client 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": "deleteMsgVpnAuthenticationKerberosRealm", "parameters": [ { "description": "The name of the Message VPN.", @@ -43155,9 +45147,9 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The Realm Name. Must start with \"@\", typically all uppercase.", "in": "path", - "name": "oauthProfileName", + "name": "kerberosRealmName", "required": true, "type": "string" }, @@ -43187,17 +45179,17 @@ "basicAuth": [] } ], - "summary": "Delete an OAuth Profile object.", + "summary": "Delete a Realm object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "authenticationKerberosRealm" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "get": { - "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfile", + "description": "Get a Realm object.\n\nKerberos Realm.\n\n\nAttribute|Identifying\n:---|:---:\nkerberosRealmName|x\nmsgVpnName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.40.", + "operationId": "getMsgVpnAuthenticationKerberosRealm", "parameters": [ { "description": "The name of the Message VPN.", @@ -43207,9 +45199,9 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The Realm Name. Must start with \"@\", typically all uppercase.", "in": "path", - "name": "oauthProfileName", + "name": "kerberosRealmName", "required": true, "type": "string" }, @@ -43228,9 +45220,9 @@ ], "responses": { "200": { - "description": "The OAuth Profile object's attributes, and the request metadata.", + "description": "The Realm object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealmResponse" } }, "default": { @@ -43245,17 +45237,17 @@ "basicAuth": [] } ], - "summary": "Get an OAuth Profile object.", + "summary": "Get a Realm object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "authenticationKerberosRealm" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "patch": { - "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "updateMsgVpnAuthenticationOauthProfile", + "description": "Update a Realm object. Any attribute missing from the request will be left unchanged.\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": "updateMsgVpnAuthenticationKerberosRealm", "parameters": [ { "description": "The name of the Message VPN.", @@ -43265,19 +45257,19 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The Realm Name. Must start with \"@\", typically all uppercase.", "in": "path", - "name": "oauthProfileName", + "name": "kerberosRealmName", "required": true, "type": "string" }, { - "description": "The OAuth Profile object's attributes.", + "description": "The Realm object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealm" } }, { @@ -43295,9 +45287,9 @@ ], "responses": { "200": { - "description": "The OAuth Profile object's attributes after being updated, and the request metadata.", + "description": "The Realm object's attributes after being updated, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealmResponse" } }, "default": { @@ -43312,17 +45304,17 @@ "basicAuth": [] } ], - "summary": "Update an OAuth Profile object.", + "summary": "Update a Realm object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "authenticationKerberosRealm" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false }, "put": { - "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|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", + "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.", + "operationId": "replaceMsgVpnAuthenticationKerberosRealm", "parameters": [ { "description": "The name of the Message VPN.", @@ -43332,19 +45324,19 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", + "description": "The Realm Name. Must start with \"@\", typically all uppercase.", "in": "path", - "name": "oauthProfileName", + "name": "kerberosRealmName", "required": true, "type": "string" }, { - "description": "The OAuth Profile object's attributes.", + "description": "The Realm object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealm" } }, { @@ -43362,9 +45354,9 @@ ], "responses": { "200": { - "description": "The OAuth Profile object's attributes after being replaced, and the request metadata.", + "description": "The Realm object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + "$ref": "#/definitions/MsgVpnAuthenticationKerberosRealmResponse" } }, "default": { @@ -43379,19 +45371,19 @@ "basicAuth": [] } ], - "summary": "Replace an OAuth Profile object.", + "summary": "Replace a Realm object.", "tags": [ "all", "msgVpn", - "authenticationOauthProfile" + "authenticationKerberosRealm" ], - "x-supportedInSempDirect": true + "x-supportedInSempDirect": false } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims": { + "/msgVpns/{msgVpnName}/authenticationOauthProfiles": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaims", + "description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfiles", "parameters": [ { "description": "The name of the Message VPN.", @@ -43400,13 +45392,6 @@ "required": true, "type": "string" }, - { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/countQuery" }, @@ -43434,9 +45419,9 @@ ], "responses": { "200": { - "description": "The list of Required Claim objects' attributes, and the request metadata.", + "description": "The list of OAuth Profile objects' attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfilesResponse" } }, "default": { @@ -43451,7 +45436,7 @@ "basicAuth": [] } ], - "summary": "Get a list of Required Claim objects.", + "summary": "Get a list of OAuth Profile objects.", "tags": [ "all", "msgVpn", @@ -43460,8 +45445,8 @@ "x-supportedInSempDirect": true }, "post": { - "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x|\nclientRequiredClaimValue||x|x|\nmsgVpnName|x|||x\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "createMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "description": "Create an OAuth Profile object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nclientSecret|||||x|x\nmsgVpnName|x|||x||\noauthProfileName|x|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -43471,19 +45456,12 @@ "type": "string" }, { - "description": "The name of the OAuth profile.", - "in": "path", - "name": "oauthProfileName", - "required": true, - "type": "string" - }, - { - "description": "The Required Claim object's attributes.", + "description": "The OAuth Profile object's attributes.", "in": "body", "name": "body", "required": true, "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" } }, { @@ -43501,9 +45479,9 @@ ], "responses": { "200": { - "description": "The Required Claim object's attributes after being created, and the request metadata.", + "description": "The OAuth Profile object's attributes after being created, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" } }, "default": { @@ -43518,7 +45496,7 @@ "basicAuth": [] } ], - "summary": "Create a Required Claim object.", + "summary": "Create an OAuth Profile object.", "tags": [ "all", "msgVpn", @@ -43527,10 +45505,10 @@ "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}": { "delete": { - "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\nA SEMP client 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": "deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "description": "Delete an OAuth Profile object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\nA SEMP client 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": "deleteMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -43547,12 +45525,63 @@ "type": "string" }, { - "description": "The name of the ID token claim to verify.", + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete an OAuth Profile object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ], + "x-supportedInSempDirect": true + }, + "get": { + "description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclientSecret||x|x\nmsgVpnName|x||\noauthProfileName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", "in": "path", - "name": "clientRequiredClaimName", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", "required": true, "type": "string" }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, { "$ref": "#/parameters/solSessionHeader" } @@ -43562,9 +45591,9 @@ ], "responses": { "200": { - "description": "The request metadata.", + "description": "The OAuth Profile object's attributes, and the request metadata.", "schema": { - "$ref": "#/definitions/SempMetaOnlyResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" } }, "default": { @@ -43579,7 +45608,7 @@ "basicAuth": [] } ], - "summary": "Delete a Required Claim object.", + "summary": "Get an OAuth Profile object.", "tags": [ "all", "msgVpn", @@ -43587,9 +45616,9 @@ ], "x-supportedInSempDirect": true }, - "get": { - "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "patch": { + "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nclientSecret||||x|x\nmsgVpnName|x||x||\noauthProfileName|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "updateMsgVpnAuthenticationOauthProfile", "parameters": [ { "description": "The name of the Message VPN.", @@ -43606,12 +45635,81 @@ "type": "string" }, { - "description": "The name of the ID token claim to verify.", + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The OAuth Profile object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update an OAuth Profile object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ], + "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.", + "operationId": "replaceMsgVpnAuthenticationOauthProfile", + "parameters": [ + { + "description": "The name of the Message VPN.", "in": "path", - "name": "clientRequiredClaimName", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", "required": true, "type": "string" }, + { + "description": "The OAuth Profile object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfile" + } + }, { "$ref": "#/parameters/opaquePasswordQuery" }, @@ -43627,9 +45725,9 @@ ], "responses": { "200": { - "description": "The Required Claim object's attributes, and the request metadata.", + "description": "The OAuth Profile object's attributes after being replaced, and the request metadata.", "schema": { - "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse" } }, "default": { @@ -43644,7 +45742,7 @@ "basicAuth": [] } ], - "summary": "Get a Required Claim object.", + "summary": "Replace an OAuth Profile object.", "tags": [ "all", "msgVpn", @@ -43653,10 +45751,275 @@ "x-supportedInSempDirect": true } }, - "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims": { "get": { - "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", - "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims", + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaims", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Required Claim objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimsResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Required Claim objects.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ], + "x-supportedInSempDirect": true + }, + "post": { + "description": "Create a Required Claim object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nclientRequiredClaimName|x|x|x|\nclientRequiredClaimValue||x|x|\nmsgVpnName|x|||x\noauthProfileName|x|||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "createMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The Required Claim object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaim" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ], + "x-supportedInSempDirect": true + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}": { + "delete": { + "description": "Delete a Required Claim object. The deletion of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nAdditional claims to be verified in the ID token.\n\nA SEMP client 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": "deleteMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ID token claim to verify.", + "in": "path", + "name": "clientRequiredClaimName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ], + "x-supportedInSempDirect": true + }, + "get": { + "description": "Get a Required Claim object.\n\nAdditional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclientRequiredClaimName|x\nmsgVpnName|x\noauthProfileName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileClientRequiredClaim", + "parameters": [ + { + "description": "The name of the Message VPN.", + "in": "path", + "name": "msgVpnName", + "required": true, + "type": "string" + }, + { + "description": "The name of the OAuth profile.", + "in": "path", + "name": "oauthProfileName", + "required": true, + "type": "string" + }, + { + "description": "The name of the ID token claim to verify.", + "in": "path", + "name": "clientRequiredClaimName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Required Claim object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClientRequiredClaimResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Required Claim object.", + "tags": [ + "all", + "msgVpn", + "authenticationOauthProfile" + ], + "x-supportedInSempDirect": true + } + }, + "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims": { + "get": { + "description": "Get a list of Required Claim objects.\n\nAdditional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\nresourceServerRequiredClaimName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.25.", + "operationId": "getMsgVpnAuthenticationOauthProfileResourceServerRequiredClaims", "parameters": [ { "description": "The name of the Message VPN.", @@ -50366,7 +52729,7 @@ }, "/msgVpns/{msgVpnName}/dmrBridges": { "get": { - "description": "Get a list of DMR Bridge objects.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.11.", + "description": "Get a list of DMR Bridge objects.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.11.", "operationId": "getMsgVpnDmrBridges", "parameters": [ { @@ -50426,7 +52789,7 @@ "msgVpn", "dmrBridge" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { "description": "Create a DMR Bridge object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nremoteNodeName|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation.\n\nThis has been available since 2.11.", @@ -50486,7 +52849,7 @@ "msgVpn", "dmrBridge" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, "/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}": { @@ -50540,7 +52903,7 @@ "msgVpn", "dmrBridge" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { "description": "Get a DMR Bridge object.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nremoteNodeName|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.11.", @@ -50598,7 +52961,7 @@ "msgVpn", "dmrBridge" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "patch": { "description": "Update a DMR Bridge object. Any attribute missing from the request will be left unchanged.\n\nA DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying|Const|Read-Only\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.", @@ -50665,7 +53028,7 @@ "msgVpn", "dmrBridge" ], - "x-supportedInSempDirect": false + "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.", @@ -50732,7 +53095,7 @@ "msgVpn", "dmrBridge" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, "/msgVpns/{msgVpnName}/jndiConnectionFactories": { @@ -51850,7 +54213,7 @@ }, "/msgVpns/{msgVpnName}/kafkaReceivers": { "get": { - "description": "Get a list of Kafka Receiver objects.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Kafka Receiver objects.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationKerberosKeytabContent||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaReceivers", "parameters": [ { @@ -51913,7 +54276,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Kafka Receiver object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaReceiverName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Create a Kafka Receiver object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationKerberosKeytabContent|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaReceiverName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|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": "createMsgVpnKafkaReceiver", "parameters": [ { @@ -52027,7 +54390,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Kafka Receiver object.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Get a Kafka Receiver object.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationKerberosKeytabContent||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaReceiverName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaReceiver", "parameters": [ { @@ -52085,7 +54448,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Kafka Receiver object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\ngroupId|||||x|\ngroupKeepaliveInterval|||||x|\ngroupKeepaliveTimeout|||||x|\ngroupMembershipType|||||x|\ngroupPartitionSchemeList|||||x|\nkafkaReceiverName|x|x||||\nmetadataTopicExcludeList|||||x|\nmetadataTopicRefreshInterval|||||x|\nmsgVpnName|x||x|||\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Update a Kafka Receiver object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\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": "updateMsgVpnKafkaReceiver", "parameters": [ { @@ -52152,7 +54515,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|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\ngroupId|||||x|\ngroupKeepaliveInterval|||||x|\ngroupKeepaliveTimeout|||||x|\ngroupMembershipType|||||x|\ngroupPartitionSchemeList|||||x|\nkafkaReceiverName|x|x||||\nmetadataTopicExcludeList|||||x|\nmetadataTopicRefreshInterval|||||x|\nmsgVpnName|x||x|||\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaReceiver|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaReceiver|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaReceiver|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "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.", "operationId": "replaceMsgVpnKafkaReceiver", "parameters": [ { @@ -52378,7 +54741,7 @@ "type": "string" }, { - "description": "The name of the Topic.", + "description": "The name of the Topic or a POSIX.2 regular expression starting with '^'.", "in": "path", "name": "topicName", "required": true, @@ -52437,7 +54800,7 @@ "type": "string" }, { - "description": "The name of the Topic.", + "description": "The name of the Topic or a POSIX.2 regular expression starting with '^'.", "in": "path", "name": "topicName", "required": true, @@ -52502,7 +54865,7 @@ "type": "string" }, { - "description": "The name of the Topic.", + "description": "The name of the Topic or a POSIX.2 regular expression starting with '^'.", "in": "path", "name": "topicName", "required": true, @@ -52576,7 +54939,7 @@ "type": "string" }, { - "description": "The name of the Topic.", + "description": "The name of the Topic or a POSIX.2 regular expression starting with '^'.", "in": "path", "name": "topicName", "required": true, @@ -52634,7 +54997,7 @@ }, "/msgVpns/{msgVpnName}/kafkaSenders": { "get": { - "description": "Get a list of Kafka Sender objects.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Kafka Sender objects.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationKerberosKeytabContent||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaSenders", "parameters": [ { @@ -52697,7 +55060,7 @@ "x-supportedInSempDirect": false }, "post": { - "description": "Create a Kafka Sender object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaSenderName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Create a Kafka Sender object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nauthenticationClientCertContent|||||x|x\nauthenticationClientCertPassword|||||x|\nauthenticationKerberosKeytabContent|||||x|\nauthenticationOauthClientSecret|||||x|x\nauthenticationScramPassword|||||x|x\nkafkaSenderName|x|x|x|||\nmsgVpnName|x|||x||\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|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": "createMsgVpnKafkaSender", "parameters": [ { @@ -52811,7 +55174,7 @@ "x-supportedInSempDirect": false }, "get": { - "description": "Get a Kafka Sender object.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Get a Kafka Sender object.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nauthenticationClientCertContent||x|x\nauthenticationClientCertPassword||x|\nauthenticationKerberosKeytabContent||x|\nauthenticationOauthClientSecret||x|x\nauthenticationScramPassword||x|x\nkafkaSenderName|x||\nmsgVpnName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnKafkaSender", "parameters": [ { @@ -52869,7 +55232,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update a Kafka Sender object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxMsgCount|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\nidempotenceEnabled|||||x|\nkafkaSenderName|x|x||||\nmsgVpnName|x||x|||\ntransportCompressionEnabled|||||x|\ntransportCompressionLevel|||||x|\ntransportCompressionType|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "description": "Update a Kafka Sender object. Any attribute missing from the request will be left unchanged.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|Auto-Disable|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x|x\nauthenticationBasicUsername|||||x|\nauthenticationClientCertContent||||x|x|x\nauthenticationClientCertPassword||||x|x|\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": "updateMsgVpnKafkaSender", "parameters": [ { @@ -52936,7 +55299,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|\nauthenticationOauthClientId|||||x|\nauthenticationOauthClientScope|||||x|\nauthenticationOauthClientSecret||||x|x|x\nauthenticationOauthClientTokenEndpoint|||||x|\nauthenticationScheme|||||x|\nauthenticationScramHash|||||x|\nauthenticationScramPassword||||x|x|x\nauthenticationScramUsername|||||x|\nbatchDelay|||||x|\nbatchMaxMsgCount|||||x|\nbatchMaxSize|||||x|\nbootstrapAddressList|||||x|\nidempotenceEnabled|||||x|\nkafkaSenderName|x|x||||\nmsgVpnName|x||x|||\ntransportCompressionEnabled|||||x|\ntransportCompressionLevel|||||x|\ntransportCompressionType|||||x|\ntransportTlsEnabled|||||x|\n\n\n\nThe following attributes in the request may only be provided in certain combinations with other attributes:\n\n\nClass|Attribute|Requires\n:---|:---|:---\nMsgVpnKafkaSender|authenticationBasicPassword|authenticationBasicUsername\nMsgVpnKafkaSender|authenticationClientCertPassword|authenticationClientCertContent\nMsgVpnKafkaSender|authenticationScramPassword|authenticationScramUsername\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", + "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.", "operationId": "replaceMsgVpnKafkaSender", "parameters": [ { @@ -54643,7 +57006,7 @@ }, "/msgVpns/{msgVpnName}/proxies": { "get": { - "description": "Get a list of Proxy objects.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nmsgVpnName|x||\nproxyName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.36.", + "description": "Get a list of Proxy objects.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nmsgVpnName|x||\nproxyName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.36.", "operationId": "getMsgVpnProxies", "parameters": [ { @@ -54703,7 +57066,7 @@ "msgVpn", "proxy" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { "description": "Create a Proxy object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Required|Read-Only|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword|||||x|x\nmsgVpnName|x|||x||\nproxyName|x|x|x|||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.36.", @@ -54763,7 +57126,7 @@ "msgVpn", "proxy" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, "/msgVpns/{msgVpnName}/proxies/{proxyName}": { @@ -54817,7 +57180,7 @@ "msgVpn", "proxy" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { "description": "Get a Proxy object.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nmsgVpnName|x||\nproxyName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.36.", @@ -54875,7 +57238,7 @@ "msgVpn", "proxy" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "patch": { "description": "Update a Proxy object. Any attribute missing from the request will be left unchanged.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Read-Only|Write-Only|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.", @@ -54942,7 +57305,7 @@ "msgVpn", "proxy" ], - "x-supportedInSempDirect": false + "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.", @@ -55009,7 +57372,7 @@ "msgVpn", "proxy" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, "/msgVpns/{msgVpnName}/queueTemplates": { @@ -56657,7 +59020,7 @@ }, "/msgVpns/{msgVpnName}/replicatedTopics": { "get": { - "description": "Get a list of Replicated Topic objects.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nThis has been available since 2.1.", + "description": "Get a list of Replicated Topic objects.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.1.", "operationId": "getMsgVpnReplicatedTopics", "parameters": [ { @@ -56717,7 +59080,7 @@ "msgVpn", "replicatedTopic" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "post": { "description": "Create a Replicated Topic object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates and replication sites via config-sync.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Required|Read-Only\n:---|:---:|:---:|:---:|:---:\nmsgVpnName|x|||x\nreplicatedTopic|x|x|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-write\" is required to perform this operation.\n\nThis has been available since 2.1.", @@ -56777,7 +59140,7 @@ "msgVpn", "replicatedTopic" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, "/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}": { @@ -56831,7 +59194,7 @@ "msgVpn", "replicatedTopic" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "get": { "description": "Get a Replicated Topic object.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplicatedTopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since 2.1.", @@ -56889,7 +59252,7 @@ "msgVpn", "replicatedTopic" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true }, "patch": { "description": "Update a Replicated Topic object. Any attribute missing from the request will be left unchanged.\n\nTo indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying|Const|Read-Only\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.", @@ -56956,7 +59319,7 @@ "msgVpn", "replicatedTopic" ], - "x-supportedInSempDirect": false + "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.", @@ -57023,7 +59386,7 @@ "msgVpn", "replicatedTopic" ], - "x-supportedInSempDirect": false + "x-supportedInSempDirect": true } }, "/msgVpns/{msgVpnName}/restDeliveryPoints": { @@ -62250,7 +64613,7 @@ "x-supportedInSempDirect": false }, "patch": { - "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret|||x|x\noauthProfileName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", + "description": "Update an OAuth Profile object. Any attribute missing from the request will be left unchanged.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret|||x|x\noauthProfileName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\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": "updateOauthProfile", "parameters": [ { @@ -62309,7 +64672,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\nresourceServerParseAccessTokenEnabled|global/admin\nresourceServerRequiredAudience|global/admin\nresourceServerRequiredIssuer|global/admin\nresourceServerRequiredScope|global/admin\nresourceServerRequiredType|global/admin\nresourceServerValidateAudienceEnabled|global/admin\nresourceServerValidateIssuerEnabled|global/admin\nresourceServerValidateScopeEnabled|global/admin\nresourceServerValidateTypeEnabled|global/admin\nsempEnabled|global/admin\nusernameClaimName|global/admin\n\n\n\nThis has been available since 2.24.", + "description": "Replace an OAuth Profile object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Const|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:\nclientSecret|||x|x\noauthProfileName|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-write\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"global/read-write\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\naccessLevelGroupsClaimName|global/admin\naccessLevelGroupsClaimStringFormat|global/admin\nclientId|global/admin\nclientRedirectUri|global/admin\nclientRequiredType|global/admin\nclientScope|global/admin\nclientSecret|global/admin\nclientValidateTypeEnabled|global/admin\ndefaultGlobalAccessLevel|global/admin\ndisplayName|global/admin\nenabled|global/admin\nendpointAuthorization|global/admin\nendpointDiscovery|global/admin\nendpointDiscoveryRefreshInterval|global/admin\nendpointIntrospection|global/admin\nendpointIntrospectionTimeout|global/admin\nendpointJwks|global/admin\nendpointJwksRefreshInterval|global/admin\nendpointToken|global/admin\nendpointTokenTimeout|global/admin\nendpointUserinfo|global/admin\nendpointUserinfoTimeout|global/admin\ninteractiveEnabled|global/admin\ninteractivePromptForExpiredSession|global/admin\ninteractivePromptForNewSession|global/admin\nissuer|global/admin\noauthRole|global/admin\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": [ { @@ -64569,6 +66932,329 @@ "x-supportedInSempDirect": false } }, + "/proxies": { + "get": { + "description": "Get a list of Proxy objects.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a OAuth Provider, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nproxyName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nThis has been available since 2.41.", + "operationId": "getProxies", + "parameters": [ + { + "$ref": "#/parameters/countQuery" + }, + { + "$ref": "#/parameters/cursorQuery" + }, + { + "$ref": "#/parameters/forceFullPageQuery" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/whereQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The list of Proxy objects' attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/ProxiesResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a list of Proxy objects.", + "tags": [ + "all", + "proxy" + ], + "x-supportedInSempDirect": true + }, + "post": { + "description": "Create a Proxy object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a OAuth Provider, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Const|Required|Write-Only|Opaque\n:---|:---:|:---:|:---:|:---:|:---:\nauthenticationBasicPassword||||x|x\nproxyName|x|x|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/admin\" is required to perform this operation.\n\nThis has been available since 2.41.", + "operationId": "createProxy", + "parameters": [ + { + "description": "The Proxy object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Proxy" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Proxy object's attributes after being created, and the request metadata.", + "schema": { + "$ref": "#/definitions/ProxyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Create a Proxy object.", + "tags": [ + "all", + "proxy" + ], + "x-supportedInSempDirect": true + } + }, + "/proxies/{proxyName}": { + "delete": { + "description": "Delete a Proxy object. The deletion of instances of this object are synchronized to HA mates via config-sync.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a OAuth Provider, select the proxy by name in the configuration for that object.\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": "deleteProxy", + "parameters": [ + { + "description": "The name of the proxy.", + "in": "path", + "name": "proxyName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The request metadata.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Delete a Proxy object.", + "tags": [ + "all", + "proxy" + ], + "x-supportedInSempDirect": true + }, + "get": { + "description": "Get a Proxy object.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a OAuth Provider, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthenticationBasicPassword||x|x\nproxyName|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since 2.41.", + "operationId": "getProxy", + "parameters": [ + { + "description": "The name of the proxy.", + "in": "path", + "name": "proxyName", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Proxy object's attributes, and the request metadata.", + "schema": { + "$ref": "#/definitions/ProxyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Get a Proxy object.", + "tags": [ + "all", + "proxy" + ], + "x-supportedInSempDirect": true + }, + "patch": { + "description": "Update a Proxy object. Any attribute missing from the request will be left unchanged.\n\nProxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a 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": "updateProxy", + "parameters": [ + { + "description": "The name of the proxy.", + "in": "path", + "name": "proxyName", + "required": true, + "type": "string" + }, + { + "description": "The Proxy object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Proxy" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Proxy object's attributes after being updated, and the request metadata.", + "schema": { + "$ref": "#/definitions/ProxyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Update a Proxy object.", + "tags": [ + "all", + "proxy" + ], + "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.", + "operationId": "replaceProxy", + "parameters": [ + { + "description": "The name of the proxy.", + "in": "path", + "name": "proxyName", + "required": true, + "type": "string" + }, + { + "description": "The Proxy object's attributes.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Proxy" + } + }, + { + "$ref": "#/parameters/opaquePasswordQuery" + }, + { + "$ref": "#/parameters/selectQuery" + }, + { + "$ref": "#/parameters/solSessionHeader" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The Proxy object's attributes after being replaced, and the request metadata.", + "schema": { + "$ref": "#/definitions/ProxyResponse" + } + }, + "default": { + "description": "The error response.", + "schema": { + "$ref": "#/definitions/SempMetaOnlyResponse" + } + } + }, + "security": [ + { + "basicAuth": [] + } + ], + "summary": "Replace a Proxy object.", + "tags": [ + "all", + "proxy" + ], + "x-supportedInSempDirect": true + } + }, "/systemInformation": { "get": { "deprecated": true, diff --git a/cmd/client/cliclient.go b/cmd/client/cliclient.go index 2dfa0c83..d4da6362 100644 --- a/cmd/client/cliclient.go +++ b/cmd/client/cliclient.go @@ -29,7 +29,7 @@ func CliClient(cliParams generator.CliParams) *semp.Client { false, // this is a client for the generator semp.BasicAuth(*cliParams.Username, *cliParams.Password), semp.BearerToken(*cliParams.Bearer_token), - semp.Retries(uint(*cliParams.Retries), *cliParams.Retry_min_interval, *cliParams.Retry_max_interval), + semp.Retries(*cliParams.Retries, *cliParams.Retry_min_interval, *cliParams.Retry_max_interval), semp.RequestLimits(*cliParams.Request_timeout_duration, *cliParams.Request_min_interval)) return client } diff --git a/cmd/generator/util_test.go b/cmd/generator/util_test.go index 5602cf1f..e596992d 100644 --- a/cmd/generator/util_test.go +++ b/cmd/generator/util_test.go @@ -191,6 +191,11 @@ func TestSanitizeHclValue(t *testing.T) { args{name: "\""}, "\\\"", }, + { + "SanitizeOnlySpecialCharacterValueFour", + args{name: "er\"rerrr\"\""}, + "er\\\"rerrr\\\"\\\"", + }, { "SanitizeSubstituitionExpression", args{name: "time/${now()}"}, diff --git a/docs/data-sources/about_api.md b/docs/data-sources/about_api.md index 15191580..6c70d803 100644 --- a/docs/data-sources/about_api.md +++ b/docs/data-sources/about_api.md @@ -3,6 +3,7 @@ page_title: "solacebroker_about_api Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. The API Description object provides metadata about the SEMP API. A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. This has been available since SEMP API version 2.2. @@ -10,6 +11,8 @@ description: |- # solacebroker_about_api (Data Source) +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). + The API Description object provides metadata about the SEMP API. diff --git a/docs/data-sources/about_user.md b/docs/data-sources/about_user.md index 32b1ac1d..ac99c927 100644 --- a/docs/data-sources/about_user.md +++ b/docs/data-sources/about_user.md @@ -3,6 +3,7 @@ page_title: "solacebroker_about_user Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Session and access level information about the user accessing the SEMP API. A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. This has been available since SEMP API version 2.2. @@ -10,6 +11,8 @@ description: |- # solacebroker_about_user (Data Source) +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). + Session and access level information about the user accessing the SEMP API. diff --git a/docs/data-sources/about_user_msg_vpn.md b/docs/data-sources/about_user_msg_vpn.md index 2d5be0cf..a5d42ba2 100644 --- a/docs/data-sources/about_user_msg_vpn.md +++ b/docs/data-sources/about_user_msg_vpn.md @@ -3,22 +3,17 @@ page_title: "solacebroker_about_user_msg_vpn Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. This provides information about the Message VPN access level for the username used to access the SEMP API. - Attribute|Identifying - :---|:---: - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "global/none" is required to perform this operation. This has been available since SEMP API version 2.2. --- # solacebroker_about_user_msg_vpn (Data Source) -This provides information about the Message VPN access level for the username used to access the SEMP API. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -msg_vpn_name|x +This provides information about the Message VPN access level for the username used to access the SEMP API. diff --git a/docs/data-sources/broker.md b/docs/data-sources/broker.md index bc002147..b7b7a24d 100644 --- a/docs/data-sources/broker.md +++ b/docs/data-sources/broker.md @@ -3,14 +3,12 @@ page_title: "solacebroker_broker Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. This object contains global configuration for the message broker. - Attribute|Write-Only|Opaque - :---|:---:|:---: - tls_server_cert_content|x|x - tls_server_cert_password|x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than "vpn/read-only": Attribute|Access Scope/Level :---|:---: + auth_brute_force_protection_enabled|global/read-only auth_client_cert_revocation_check_mode|global/read-only config_sync_authentication_client_cert_max_chain_depth|global/read-only config_sync_authentication_client_cert_validate_date_enabled|global/read-only @@ -134,13 +132,9 @@ description: |- # solacebroker_broker (Data Source) -This object contains global configuration for the message broker. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Write-Only|Opaque -:---|:---:|:---: -tls_server_cert_content|x|x -tls_server_cert_password|x| +This object contains global configuration for the message broker. @@ -149,6 +143,7 @@ A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is Attribute|Access Scope/Level :---|:---: +auth_brute_force_protection_enabled|global/read-only auth_client_cert_revocation_check_mode|global/read-only config_sync_authentication_client_cert_max_chain_depth|global/read-only config_sync_authentication_client_cert_validate_date_enabled|global/read-only @@ -279,6 +274,7 @@ This has been available since SEMP API version 2.13. ### Read-Only +- `auth_brute_force_protection_enabled` (Boolean) Enable or disable protection against brute force password guessing attacks on local management accounts. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since SEMP API version 2.40. - `auth_client_cert_revocation_check_mode` (String) The client certificate revocation checking mode used when a client authenticates with a client certificate. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"none"`. The allowed values and their meaning are: 
diff --git a/docs/data-sources/client_cert_authority.md b/docs/data-sources/client_cert_authority.md
index 42cdd4aa..23ff7545 100644
--- a/docs/data-sources/client_cert_authority.md
+++ b/docs/data-sources/client_cert_authority.md
@@ -3,22 +3,17 @@
 page_title: "solacebroker_client_cert_authority Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.
-  Attribute|Identifying
-  :---|:---:
-  cert_authority_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.19.
 ---
 
 # solacebroker_client_cert_authority (Data Source)
 
-Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-cert_authority_name|x
+Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.
 
 
 
diff --git a/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md b/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md
index 7ab05a22..bdcefeea 100644
--- a/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md
+++ b/docs/data-sources/client_cert_authority_ocsp_tls_trusted_common_name.md
@@ -3,24 +3,17 @@
 page_title: "solacebroker_client_cert_authority_ocsp_tls_trusted_common_name Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.
-  Attribute|Identifying
-  :---|:---:
-  cert_authority_name|x
-  ocsp_tls_trusted_common_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.19.
 ---
 
 # solacebroker_client_cert_authority_ocsp_tls_trusted_common_name (Data Source)
 
-When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-cert_authority_name|x
-ocsp_tls_trusted_common_name|x
+When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.
 
 
 
diff --git a/docs/data-sources/dmr_cluster.md b/docs/data-sources/dmr_cluster.md
index 001375ff..8270d384 100644
--- a/docs/data-sources/dmr_cluster.md
+++ b/docs/data-sources/dmr_cluster.md
@@ -3,30 +3,17 @@
 page_title: "solacebroker_dmr_cluster Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authentication_basic_password||x||x
-  authentication_client_cert_content||x||x
-  authentication_client_cert_password||x||
-  dmr_cluster_name|x|||
-  tls_server_cert_enforce_trusted_common_name_enabled|||x|
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
 ---
 
 # solacebroker_dmr_cluster (Data Source)
 
-A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_basic_password||x||x
-authentication_client_cert_content||x||x
-authentication_client_cert_password||x||
-dmr_cluster_name|x|||
-tls_server_cert_enforce_trusted_common_name_enabled|||x|
+A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
 
 
 
diff --git a/docs/data-sources/dmr_cluster_cert_matching_rule.md b/docs/data-sources/dmr_cluster_cert_matching_rule.md
index d60d41a3..50d5e0eb 100644
--- a/docs/data-sources/dmr_cluster_cert_matching_rule.md
+++ b/docs/data-sources/dmr_cluster_cert_matching_rule.md
@@ -3,24 +3,17 @@
 page_title: "solacebroker_dmr_cluster_cert_matching_rule Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  rule_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
 ---
 
 # solacebroker_dmr_cluster_cert_matching_rule (Data Source)
 
-A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-rule_name|x
+A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
 
 
 
diff --git a/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md b/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md
index 4814465f..ad886fdd 100644
--- a/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md
+++ b/docs/data-sources/dmr_cluster_cert_matching_rule_attribute_filter.md
@@ -3,26 +3,17 @@
 page_title: "solacebroker_dmr_cluster_cert_matching_rule_attribute_filter Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cert Matching Rule Attribute Filter compares a link attribute to a string.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  filter_name|x
-  rule_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
 ---
 
 # solacebroker_dmr_cluster_cert_matching_rule_attribute_filter (Data Source)
 
-A Cert Matching Rule Attribute Filter compares a link attribute to a string.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-filter_name|x
-rule_name|x
+A Cert Matching Rule Attribute Filter compares a link attribute to a string.
 
 
 
diff --git a/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md b/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md
index 2f929c16..f89ef230 100644
--- a/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md
+++ b/docs/data-sources/dmr_cluster_cert_matching_rule_condition.md
@@ -3,26 +3,17 @@
 page_title: "solacebroker_dmr_cluster_cert_matching_rule_condition Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  rule_name|x
-  source|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
 ---
 
 # solacebroker_dmr_cluster_cert_matching_rule_condition (Data Source)
 
-A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-rule_name|x
-source|x
+A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
 
 
 
diff --git a/docs/data-sources/dmr_cluster_link.md b/docs/data-sources/dmr_cluster_link.md
index 380fa6fc..c6247c8a 100644
--- a/docs/data-sources/dmr_cluster_link.md
+++ b/docs/data-sources/dmr_cluster_link.md
@@ -3,26 +3,17 @@
 page_title: "solacebroker_dmr_cluster_link Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
-  Attribute|Identifying|Write-Only|Opaque
-  :---|:---:|:---:|:---:
-  authentication_basic_password||x|x
-  dmr_cluster_name|x||
-  remote_node_name|x||
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
 ---
 
 # solacebroker_dmr_cluster_link (Data Source)
 
-A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying|Write-Only|Opaque
-:---|:---:|:---:|:---:
-authentication_basic_password||x|x
-dmr_cluster_name|x||
-remote_node_name|x||
+A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
 
 
 
@@ -64,6 +55,8 @@ This has been available since SEMP API version 2.11.
 - `client_profile_tcp_keepalive_interval` (Number) The amount of time between TCP keepalive retransmissions when no acknowledgment is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.
 - `client_profile_tcp_max_segment_size` (Number) The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`.
 - `client_profile_tcp_max_window_size` (Number) The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. This setting is ignored on the software broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`.
+- `connection_retry_count` (Number) The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since SEMP API version 2.41.
+- `connection_retry_delay` (Number) The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. Available since SEMP API version 2.41.
 - `egress_flow_window_size` (Number) The number of outstanding guaranteed messages that can be sent over the Link before acknowledgment is received by the sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.
 - `enabled` (Boolean) Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.
 - `initiator` (String) The initiator of the Link's TCP connections. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"lexical"`. The allowed values and their meaning are:
diff --git a/docs/data-sources/dmr_cluster_link_attribute.md b/docs/data-sources/dmr_cluster_link_attribute.md
index c847d340..99276301 100644
--- a/docs/data-sources/dmr_cluster_link_attribute.md
+++ b/docs/data-sources/dmr_cluster_link_attribute.md
@@ -3,28 +3,17 @@
 page_title: "solacebroker_dmr_cluster_link_attribute Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
-  Attribute|Identifying
-  :---|:---:
-  attribute_name|x
-  attribute_value|x
-  dmr_cluster_name|x
-  remote_node_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
 ---
 
 # solacebroker_dmr_cluster_link_attribute (Data Source)
 
-A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-attribute_name|x
-attribute_value|x
-dmr_cluster_name|x
-remote_node_name|x
+A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
 
 
 
diff --git a/docs/data-sources/dmr_cluster_link_remote_address.md b/docs/data-sources/dmr_cluster_link_remote_address.md
index be8b90c1..fcd24cfc 100644
--- a/docs/data-sources/dmr_cluster_link_remote_address.md
+++ b/docs/data-sources/dmr_cluster_link_remote_address.md
@@ -3,26 +3,17 @@
 page_title: "solacebroker_dmr_cluster_link_remote_address Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  remote_address|x
-  remote_node_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
 ---
 
 # solacebroker_dmr_cluster_link_remote_address (Data Source)
 
-Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-remote_address|x
-remote_node_name|x
+Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
 
 
 
diff --git a/docs/data-sources/domain_cert_authority.md b/docs/data-sources/domain_cert_authority.md
index e6830125..588fb747 100644
--- a/docs/data-sources/domain_cert_authority.md
+++ b/docs/data-sources/domain_cert_authority.md
@@ -3,22 +3,17 @@
 page_title: "solacebroker_domain_cert_authority Data Source - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   Certificate Authorities trusted for domain verification.
-  Attribute|Identifying
-  :---|:---:
-  cert_authority_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.19.
 ---
 
 # solacebroker_domain_cert_authority (Data Source)
 
-Certificate Authorities trusted for domain verification.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-cert_authority_name|x
+Certificate Authorities trusted for domain verification.
 
 
 
diff --git a/docs/data-sources/msg_vpn.md b/docs/data-sources/msg_vpn.md
index bdd8fdad..0042fa3a 100644
--- a/docs/data-sources/msg_vpn.md
+++ b/docs/data-sources/msg_vpn.md
@@ -4,17 +4,6 @@ page_title: "solacebroker_msg_vpn Data Source - solacebroker"
 subcategory: ""
 description: |-
   Message 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.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authentication_oauth_default_provider_name|||x|
-  bridging_tls_server_cert_enforce_trusted_common_name_enabled|||x|
-  distributed_cache_management_enabled|||x|
-  msg_vpn_name|x|||
-  replication_bridge_authentication_basic_password||x||x
-  replication_bridge_authentication_client_cert_content||x||x
-  replication_bridge_authentication_client_cert_password||x||
-  replication_enabled_queue_behavior||x||
-  rest_tls_server_cert_enforce_trusted_common_name_enabled|||x|
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
 ---
@@ -24,19 +13,6 @@ description: |-
 Message 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.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_oauth_default_provider_name|||x|
-bridging_tls_server_cert_enforce_trusted_common_name_enabled|||x|
-distributed_cache_management_enabled|||x|
-msg_vpn_name|x|||
-replication_bridge_authentication_basic_password||x||x
-replication_bridge_authentication_client_cert_content||x||x
-replication_bridge_authentication_client_cert_password||x||
-replication_enabled_queue_behavior||x||
-rest_tls_server_cert_enforce_trusted_common_name_enabled|||x|
-
-
 
 A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
 
@@ -69,9 +45,9 @@ Changes to this attribute are synchronized to HA mates and replication sites via
 "radius" - RADIUS authentication. A RADIUS profile name must be provided.
 "none" - No authentication. Anonymous login allowed.
-- `authentication_client_cert_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_client_cert_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `authentication_client_cert_certificate_matching_rules_enabled` (Boolean) Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.27. -- `authentication_client_cert_enabled` (Boolean) Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_client_cert_enabled` (Boolean) Enable or disable client certificate authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `authentication_client_cert_max_chain_depth` (Number) The maximum depth for a client 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 and replication sites via config-sync. The default value is `3`. - `authentication_client_cert_revocation_check_mode` (String) The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"allow-valid"`. The allowed values and their meaning are: @@ -93,10 +69,10 @@ Changes to this attribute are synchronized to HA mates and replication sites via Available since SEMP API version 2.6. - `authentication_client_cert_validate_date_enabled` (Boolean) Enable or disable validation of the "Not Before" and "Not After" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. -- `authentication_kerberos_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `authentication_kerberos_enabled` (Boolean) Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_kerberos_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_kerberos_enabled` (Boolean) Enable or disable Kerberos authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `authentication_oauth_default_profile_name` (String) The name of the profile to use when the client does not supply a profile 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.25. -- `authentication_oauth_enabled` (Boolean) Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13. +- `authentication_oauth_enabled` (Boolean) Enable or disable OAuth authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13. - `authorization_ldap_group_membership_attribute_name` (String) The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"memberOf"`. - `authorization_ldap_trim_client_username_domain_enabled` (Boolean) Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurrence of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13. - `authorization_profile_name` (String) The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. @@ -149,7 +125,7 @@ Changes to this attribute are synchronized to HA mates and replication sites via - `max_ingress_flow_count` (Number) The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - `max_kafka_broker_connection_count` (Number) The maximum number of simultaneous Kafka broker connections of the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since SEMP API version 2.39. - `max_msg_spool_usage` (Number) The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. -- `max_subscription_count` (Number) The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. +- `max_subscription_count` (Number) The maximum number of local subscriptions that can be added to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500000`. - `max_transacted_session_count` (Number) The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - `max_transaction_count` (Number) The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - `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. diff --git a/docs/data-sources/msg_vpn_acl_profile.md b/docs/data-sources/msg_vpn_acl_profile.md index 4bd7b104..5de33d82 100644 --- a/docs/data-sources/msg_vpn_acl_profile.md +++ b/docs/data-sources/msg_vpn_acl_profile.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_acl_profile Data Source - solacebroker" subcategory: "" description: |- An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,12 +13,6 @@ description: |- An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md b/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md index 9dff3baf..dca8cb96 100644 --- a/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md +++ b/docs/data-sources/msg_vpn_acl_profile_client_connect_exception.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_acl_profile_client_connect_exception Data Sour subcategory: "" description: |- A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. - Attribute|Identifying - :---|:---: - acl_profile_name|x - client_connect_exception_address|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,13 +13,6 @@ description: |- A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. -Attribute|Identifying -:---|:---: -acl_profile_name|x -client_connect_exception_address|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md b/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md index ca31b6d0..78849a74 100644 --- a/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md +++ b/docs/data-sources/msg_vpn_acl_profile_publish_topic_exception.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_acl_profile_publish_topic_exception Data Sourc subcategory: "" description: |- A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x - publish_topic_exception|x - publish_topic_exception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,14 +13,6 @@ description: |- A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x -publish_topic_exception|x -publish_topic_exception_syntax|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md b/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md index 0e1dfa2d..f7a1a27d 100644 --- a/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md +++ b/docs/data-sources/msg_vpn_acl_profile_subscribe_share_name_exception.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_share_name_exception Dat subcategory: "" description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x - subscribe_share_name_exception|x - subscribe_share_name_exception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,14 +13,6 @@ description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x -subscribe_share_name_exception|x -subscribe_share_name_exception_syntax|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md b/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md index aca4669a..5e1c8dc5 100644 --- a/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md +++ b/docs/data-sources/msg_vpn_acl_profile_subscribe_topic_exception.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_topic_exception Data Sou subcategory: "" description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x - subscribe_topic_exception|x - subscribe_topic_exception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -19,14 +13,6 @@ description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x -subscribe_topic_exception|x -subscribe_topic_exception_syntax|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_authentication_kerberos_realm.md b/docs/data-sources/msg_vpn_authentication_kerberos_realm.md new file mode 100644 index 00000000..0bd0f09c --- /dev/null +++ b/docs/data-sources/msg_vpn_authentication_kerberos_realm.md @@ -0,0 +1,34 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "solacebroker_msg_vpn_authentication_kerberos_realm Data Source - solacebroker" +subcategory: "" +description: |- + Kerberos Realm. + 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.40. +--- + +# solacebroker_msg_vpn_authentication_kerberos_realm (Data Source) + +Kerberos Realm. + + + +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.40. + + + + +## Schema + +### Required + +- `kerberos_realm_name` (String) The Realm Name. Must start with "@", typically all uppercase. +- `msg_vpn_name` (String) The name of the Message VPN. + +### Read-Only + +- `enabled` (Boolean) Enable or disable the Realm. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `kdc_address` (String) Address (FQDN or IP) and optional port of the Key Distribution Center for principals in this 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 `""`. diff --git a/docs/data-sources/msg_vpn_authentication_oauth_profile.md b/docs/data-sources/msg_vpn_authentication_oauth_profile.md index 2ed5b952..450fa67d 100644 --- a/docs/data-sources/msg_vpn_authentication_oauth_profile.md +++ b/docs/data-sources/msg_vpn_authentication_oauth_profile.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile Data Source - sol subcategory: "" description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - client_secret||x|x - msg_vpn_name|x|| - oauth_profile_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,13 +13,6 @@ description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -client_secret||x|x -msg_vpn_name|x|| -oauth_profile_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -71,6 +59,7 @@ This has been available since SEMP API version 2.25. "client" - The broker is in the OAuth client role. "resource-server" - The broker is in the OAuth resource server role. +- `proxy_name` (String) The name of the proxy to use for discovery, user info, jwks, and introspection requests. 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.41. - `resource_server_parse_access_token_enabled` (Boolean) Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `resource_server_required_audience` (String) The required audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `resource_server_required_issuer` (String) The required issuer value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. diff --git a/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md b/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md index a3a631bf..be37c2ec 100644 --- a/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md +++ b/docs/data-sources/msg_vpn_authentication_oauth_profile_client_required_claim.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_client_required_c subcategory: "" description: |- Additional claims to be verified in the ID token. - Attribute|Identifying - :---|:---: - client_required_claim_name|x - msg_vpn_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,13 +13,6 @@ description: |- Additional claims to be verified in the ID token. -Attribute|Identifying -:---|:---: -client_required_claim_name|x -msg_vpn_name|x -oauth_profile_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md b/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md index b2e8adc9..7b75b106 100644 --- a/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md +++ b/docs/data-sources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_resource_server_r subcategory: "" description: |- Additional claims to be verified in the access token. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - oauth_profile_name|x - resource_server_required_claim_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. --- @@ -18,13 +13,6 @@ description: |- Additional claims to be verified in the access token. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -oauth_profile_name|x -resource_server_required_claim_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_authorization_group.md b/docs/data-sources/msg_vpn_authorization_group.md index fdecddd8..2c867af3 100644 --- a/docs/data-sources/msg_vpn_authorization_group.md +++ b/docs/data-sources/msg_vpn_authorization_group.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_authorization_group Data Source - solacebroker subcategory: "" description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - Attribute|Identifying|Write-Only - :---|:---:|:---: - authorization_group_name|x| - msg_vpn_name|x| - order_after_authorization_group_name||x - order_before_authorization_group_name||x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -19,14 +13,6 @@ description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. -Attribute|Identifying|Write-Only -:---|:---:|:---: -authorization_group_name|x| -msg_vpn_name|x| -order_after_authorization_group_name||x -order_before_authorization_group_name||x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_bridge.md b/docs/data-sources/msg_vpn_bridge.md index 5b1bcf11..8a62bfef 100644 --- a/docs/data-sources/msg_vpn_bridge.md +++ b/docs/data-sources/msg_vpn_bridge.md @@ -4,14 +4,6 @@ page_title: "solacebroker_msg_vpn_bridge Data Source - solacebroker" subcategory: "" description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - bridge_name|x|| - bridge_virtual_router|x|| - msg_vpn_name|x|| - remote_authentication_basic_password||x|x - remote_authentication_client_cert_content||x|x - remote_authentication_client_cert_password||x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -21,16 +13,6 @@ description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -bridge_name|x|| -bridge_virtual_router|x|| -msg_vpn_name|x|| -remote_authentication_basic_password||x|x -remote_authentication_client_cert_content||x|x -remote_authentication_client_cert_password||x| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -64,7 +46,7 @@ This has been available since SEMP API version 2.0. "basic" - Basic Authentication Scheme (via username and password). "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content). -- `remote_connection_retry_count` (Number) The maximum number of retry attempts to establish a connection to the remote Message VPN. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. +- `remote_connection_retry_count` (Number) The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - `remote_connection_retry_delay` (Number) The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - `remote_deliver_to_one_priority` (String) The priority for deliver-to-one (DTO) messages transmitted from 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 `"p1"`. The allowed values and their meaning are: diff --git a/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md b/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md index 0c16e9a0..66efb03a 100644 --- a/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md +++ b/docs/data-sources/msg_vpn_bridge_remote_msg_vpn.md @@ -4,15 +4,6 @@ page_title: "solacebroker_msg_vpn_bridge_remote_msg_vpn Data Source - solacebrok subcategory: "" description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - bridge_name|x|| - bridge_virtual_router|x|| - msg_vpn_name|x|| - password||x|x - remote_msg_vpn_interface|x|| - remote_msg_vpn_location|x|| - remote_msg_vpn_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -22,17 +13,6 @@ description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -bridge_name|x|| -bridge_virtual_router|x|| -msg_vpn_name|x|| -password||x|x -remote_msg_vpn_interface|x|| -remote_msg_vpn_location|x|| -remote_msg_vpn_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_bridge_remote_subscription.md b/docs/data-sources/msg_vpn_bridge_remote_subscription.md index ba7b60ef..c5cc0fdf 100644 --- a/docs/data-sources/msg_vpn_bridge_remote_subscription.md +++ b/docs/data-sources/msg_vpn_bridge_remote_subscription.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_bridge_remote_subscription Data Source - solac subcategory: "" description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - Attribute|Identifying - :---|:---: - bridge_name|x - bridge_virtual_router|x - msg_vpn_name|x - remote_subscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -19,14 +13,6 @@ description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. -Attribute|Identifying -:---|:---: -bridge_name|x -bridge_virtual_router|x -msg_vpn_name|x -remote_subscription_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_cert_matching_rule.md b/docs/data-sources/msg_vpn_cert_matching_rule.md index 0dbcc131..265dd0f1 100644 --- a/docs/data-sources/msg_vpn_cert_matching_rule.md +++ b/docs/data-sources/msg_vpn_cert_matching_rule.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule Data Source - solacebroker" subcategory: "" description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - rule_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -17,12 +13,6 @@ description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -rule_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md b/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md index ec1cd6b8..b77f7579 100644 --- a/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md +++ b/docs/data-sources/msg_vpn_cert_matching_rule_attribute_filter.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_attribute_filter Data Sourc subcategory: "" description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. - Attribute|Identifying - :---|:---: - filter_name|x - msg_vpn_name|x - rule_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. --- @@ -18,13 +13,6 @@ description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. -Attribute|Identifying -:---|:---: -filter_name|x -msg_vpn_name|x -rule_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_cert_matching_rule_condition.md b/docs/data-sources/msg_vpn_cert_matching_rule_condition.md index 819a4664..bca39c8a 100644 --- a/docs/data-sources/msg_vpn_cert_matching_rule_condition.md +++ b/docs/data-sources/msg_vpn_cert_matching_rule_condition.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_condition Data Source - sol subcategory: "" description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - rule_name|x - source|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -18,13 +13,6 @@ description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -rule_name|x -source|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_client_profile.md b/docs/data-sources/msg_vpn_client_profile.md index e429a0e3..901684c1 100644 --- a/docs/data-sources/msg_vpn_client_profile.md +++ b/docs/data-sources/msg_vpn_client_profile.md @@ -4,13 +4,6 @@ page_title: "solacebroker_msg_vpn_client_profile Data Source - solacebroker" subcategory: "" description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - Attribute|Identifying|Deprecated - :---|:---:|:---: - allow_cut_through_forwarding_enabled||x - api_queue_management_copy_from_on_create_name||x - api_topic_endpoint_management_copy_from_on_create_name||x - client_profile_name|x| - msg_vpn_name|x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -20,15 +13,6 @@ description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. -Attribute|Identifying|Deprecated -:---|:---:|:---: -allow_cut_through_forwarding_enabled||x -api_queue_management_copy_from_on_create_name||x -api_topic_endpoint_management_copy_from_on_create_name||x -client_profile_name|x| -msg_vpn_name|x| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_client_username.md b/docs/data-sources/msg_vpn_client_username.md index 41d1d72f..d6fbfa72 100644 --- a/docs/data-sources/msg_vpn_client_username.md +++ b/docs/data-sources/msg_vpn_client_username.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_client_username Data Source - solacebroker" subcategory: "" description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - client_username|x|| - msg_vpn_name|x|| - password||x|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,13 +13,6 @@ description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -client_username|x|| -msg_vpn_name|x|| -password||x|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_client_username_attribute.md b/docs/data-sources/msg_vpn_client_username_attribute.md index f3aef498..ff547710 100644 --- a/docs/data-sources/msg_vpn_client_username_attribute.md +++ b/docs/data-sources/msg_vpn_client_username_attribute.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_client_username_attribute Data Source - solace subcategory: "" description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - Attribute|Identifying - :---|:---: - attribute_name|x - attribute_value|x - client_username|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -19,14 +13,6 @@ description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. -Attribute|Identifying -:---|:---: -attribute_name|x -attribute_value|x -client_username|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_distributed_cache.md b/docs/data-sources/msg_vpn_distributed_cache.md index d0eeef4a..bc9abd02 100644 --- a/docs/data-sources/msg_vpn_distributed_cache.md +++ b/docs/data-sources/msg_vpn_distributed_cache.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_distributed_cache Data Source - solacebroker" subcategory: "" description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - Attribute|Identifying - :---|:---: - cache_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,12 +13,6 @@ description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. -Attribute|Identifying -:---|:---: -cache_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster.md b/docs/data-sources/msg_vpn_distributed_cache_cluster.md index a9eba051..c160a7b4 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster Data Source - solace subcategory: "" description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -18,13 +13,6 @@ description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md index 197cbb9a..5923d1e9 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - home_cluster_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,14 +13,6 @@ description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -home_cluster_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md index 35379f2c..913b09f8 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md @@ -4,13 +4,6 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - home_cluster_name|x - msg_vpn_name|x - topic_prefix|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -20,15 +13,6 @@ description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -home_cluster_name|x -msg_vpn_name|x -topic_prefix|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -45,4 +29,4 @@ This has been available since SEMP API version 2.11. - `cluster_name` (String) The name of the Cache Cluster. - `home_cluster_name` (String) The name of the remote Home Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. -- `topic_prefix` (String) A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. +- `topic_prefix` (String) A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md index efe0caac..b5b756ae 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_instance.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_instance Data Source subcategory: "" description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - instance_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,14 +13,6 @@ description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -instance_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md b/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md index 8d99d7ca..71944e0a 100644 --- a/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md +++ b/docs/data-sources/msg_vpn_distributed_cache_cluster_topic.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_topic Data Source - subcategory: "" description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - msg_vpn_name|x - topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -19,14 +13,6 @@ description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -msg_vpn_name|x -topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_dmr_bridge.md b/docs/data-sources/msg_vpn_dmr_bridge.md index afcf5ef7..7793aba0 100644 --- a/docs/data-sources/msg_vpn_dmr_bridge.md +++ b/docs/data-sources/msg_vpn_dmr_bridge.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_dmr_bridge Data Source - solacebroker" subcategory: "" description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - remote_node_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,12 +13,6 @@ description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -remote_node_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_jndi_connection_factory.md b/docs/data-sources/msg_vpn_jndi_connection_factory.md index 216cb9cb..5db74fe1 100644 --- a/docs/data-sources/msg_vpn_jndi_connection_factory.md +++ b/docs/data-sources/msg_vpn_jndi_connection_factory.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_jndi_connection_factory Data Source - solacebr subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - Attribute|Identifying - :---|:---: - connection_factory_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -17,12 +13,6 @@ description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. -Attribute|Identifying -:---|:---: -connection_factory_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_jndi_queue.md b/docs/data-sources/msg_vpn_jndi_queue.md index cc6a2541..c2d060f0 100644 --- a/docs/data-sources/msg_vpn_jndi_queue.md +++ b/docs/data-sources/msg_vpn_jndi_queue.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_jndi_queue Data Source - solacebroker" subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -17,12 +13,6 @@ description: |- The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_jndi_topic.md b/docs/data-sources/msg_vpn_jndi_topic.md index a1fd24eb..4f98a886 100644 --- a/docs/data-sources/msg_vpn_jndi_topic.md +++ b/docs/data-sources/msg_vpn_jndi_topic.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_jndi_topic Data Source - solacebroker" subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - topic_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. --- @@ -17,12 +13,6 @@ description: |- The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -topic_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_kafka_receiver.md b/docs/data-sources/msg_vpn_kafka_receiver.md index b2806025..577a3a3e 100644 --- a/docs/data-sources/msg_vpn_kafka_receiver.md +++ b/docs/data-sources/msg_vpn_kafka_receiver.md @@ -4,15 +4,6 @@ page_title: "solacebroker_msg_vpn_kafka_receiver Data Source - solacebroker" subcategory: "" description: |- A Kafka Receiver receives messages from a Kafka Cluster. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_basic_password||x|x - authentication_client_cert_content||x|x - authentication_client_cert_password||x| - authentication_oauth_client_secret||x|x - authentication_scram_password||x|x - kafka_receiver_name|x|| - msg_vpn_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -22,17 +13,6 @@ description: |- A Kafka Receiver receives messages from a Kafka Cluster. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_basic_password||x|x -authentication_client_cert_content||x|x -authentication_client_cert_password||x| -authentication_oauth_client_secret||x|x -authentication_scram_password||x|x -kafka_receiver_name|x|| -msg_vpn_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -51,6 +31,9 @@ This has been available since SEMP API version 2.36. ### Read-Only - `authentication_basic_username` (String) The username the Kafka Receiver uses to login to the remote Kafka broker. 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_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_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 `""`. @@ -61,6 +44,7 @@ This has been available since SEMP API version 2.36. "basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports. +"kerberos" - Kerberos Authentication. "oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports. - `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: @@ -116,6 +100,6 @@ Modifying this attribute while the object (or the relevant part of the object) i This corresponds to the Kafka consumer API `partition.assignment.strategy` configuration setting. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"range,roundrobin"`. -- `metadata_topic_exclude_list` (String) A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `metadata_topic_exclude_list` (String) A comma-separated list of POSIX.2 regular expressions. Commas within each regular expression must be escaped as double commas. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `metadata_topic_refresh_interval` (Number) The time between refreshes of topic metadata from the Kafka Cluster. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`. - `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Receiver. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. diff --git a/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md b/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md index e21b31d6..ad35022f 100644 --- a/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md +++ b/docs/data-sources/msg_vpn_kafka_receiver_topic_binding.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_kafka_receiver_topic_binding Data Source - sol subcategory: "" description: |- A Topic Binding receives messages from a remote Kafka Topic. - Attribute|Identifying - :---|:---: - kafka_receiver_name|x - msg_vpn_name|x - topic_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -18,13 +13,6 @@ description: |- A Topic Binding receives messages from a remote Kafka Topic. -Attribute|Identifying -:---|:---: -kafka_receiver_name|x -msg_vpn_name|x -topic_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -39,7 +27,7 @@ This has been available since SEMP API version 2.36. - `kafka_receiver_name` (String) The name of the Kafka Receiver. - `msg_vpn_name` (String) The name of the Message VPN. -- `topic_name` (String) The name of the Topic. +- `topic_name` (String) The name of the Topic or a POSIX.2 regular expression starting with '^'. ### Read-Only diff --git a/docs/data-sources/msg_vpn_kafka_sender.md b/docs/data-sources/msg_vpn_kafka_sender.md index 4c3d9340..5f315646 100644 --- a/docs/data-sources/msg_vpn_kafka_sender.md +++ b/docs/data-sources/msg_vpn_kafka_sender.md @@ -4,15 +4,6 @@ page_title: "solacebroker_msg_vpn_kafka_sender Data Source - solacebroker" subcategory: "" description: |- A Kafka Sender sends messages to a Kafka Cluster. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_basic_password||x|x - authentication_client_cert_content||x|x - authentication_client_cert_password||x| - authentication_oauth_client_secret||x|x - authentication_scram_password||x|x - kafka_sender_name|x|| - msg_vpn_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -22,17 +13,6 @@ description: |- A Kafka Sender sends messages to a Kafka Cluster. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_basic_password||x|x -authentication_client_cert_content||x|x -authentication_client_cert_password||x| -authentication_oauth_client_secret||x|x -authentication_scram_password||x|x -kafka_sender_name|x|| -msg_vpn_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -51,6 +31,9 @@ This has been available since SEMP API version 2.36. ### Read-Only - `authentication_basic_username` (String) The username the Kafka Sender uses to login to the remote Kafka broker. 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_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_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 `""`. @@ -61,6 +44,7 @@ This has been available since SEMP API version 2.36. "basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports. +"kerberos" - Kerberos Authentication. "oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports. - `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: diff --git a/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md b/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md index 08c669ba..714ae834 100644 --- a/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md +++ b/docs/data-sources/msg_vpn_kafka_sender_queue_binding.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_kafka_sender_queue_binding Data Source - solac subcategory: "" description: |- A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic. - Attribute|Identifying - :---|:---: - kafka_sender_name|x - msg_vpn_name|x - queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- @@ -18,13 +13,6 @@ description: |- A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic. -Attribute|Identifying -:---|:---: -kafka_sender_name|x -msg_vpn_name|x -queue_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_mqtt_retain_cache.md b/docs/data-sources/msg_vpn_mqtt_retain_cache.md index b37b377a..98df1436 100644 --- a/docs/data-sources/msg_vpn_mqtt_retain_cache.md +++ b/docs/data-sources/msg_vpn_mqtt_retain_cache.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_mqtt_retain_cache Data Source - solacebroker" subcategory: "" description: |- Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - Attribute|Identifying - :---|:---: - cache_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. --- @@ -17,12 +13,6 @@ description: |- Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. -Attribute|Identifying -:---|:---: -cache_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_mqtt_session.md b/docs/data-sources/msg_vpn_mqtt_session.md index 7b24854f..9fbfffe6 100644 --- a/docs/data-sources/msg_vpn_mqtt_session.md +++ b/docs/data-sources/msg_vpn_mqtt_session.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_mqtt_session Data Source - solacebroker" subcategory: "" description: |- An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - Attribute|Identifying - :---|:---: - mqtt_session_client_id|x - mqtt_session_virtual_router|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -18,13 +13,6 @@ description: |- An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). -Attribute|Identifying -:---|:---: -mqtt_session_client_id|x -mqtt_session_virtual_router|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_mqtt_session_subscription.md b/docs/data-sources/msg_vpn_mqtt_session_subscription.md index 073ad201..1d1ef540 100644 --- a/docs/data-sources/msg_vpn_mqtt_session_subscription.md +++ b/docs/data-sources/msg_vpn_mqtt_session_subscription.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_mqtt_session_subscription Data Source - solace subcategory: "" description: |- An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - Attribute|Identifying - :---|:---: - mqtt_session_client_id|x - mqtt_session_virtual_router|x - msg_vpn_name|x - subscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -19,14 +13,6 @@ description: |- An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. -Attribute|Identifying -:---|:---: -mqtt_session_client_id|x -mqtt_session_virtual_router|x -msg_vpn_name|x -subscription_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_proxy.md b/docs/data-sources/msg_vpn_proxy.md index 9b40b5c7..892c6362 100644 --- a/docs/data-sources/msg_vpn_proxy.md +++ b/docs/data-sources/msg_vpn_proxy.md @@ -3,26 +3,14 @@ page_title: "solacebroker_msg_vpn_proxy Data Source - solacebroker" subcategory: "" description: |- - Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_basic_password||x|x - msg_vpn_name|x|| - proxy_name|x|| + proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. --- # solacebroker_msg_vpn_proxy (Data Source) -Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. - - -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_basic_password||x|x -msg_vpn_name|x|| -proxy_name|x|| +proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. @@ -49,7 +37,7 @@ This has been available since SEMP API version 2.36. "none" - No authentication. "basic" - Username/password authentication. -- `enabled` (Boolean) Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. +- `enabled` (Boolean) Enable or disable the proxy. When disabled, no connections are initiated to this particular proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `host` (String) The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `port` (Number) The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. - `proxy_type` (String) The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"direct"`. The allowed values and their meaning are: diff --git a/docs/data-sources/msg_vpn_queue.md b/docs/data-sources/msg_vpn_queue.md index bfe2c14c..0b89ac7a 100644 --- a/docs/data-sources/msg_vpn_queue.md +++ b/docs/data-sources/msg_vpn_queue.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_queue Data Source - solacebroker" subcategory: "" description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,12 +13,6 @@ description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_queue_subscription.md b/docs/data-sources/msg_vpn_queue_subscription.md index 9df5b45e..7fd49dc3 100644 --- a/docs/data-sources/msg_vpn_queue_subscription.md +++ b/docs/data-sources/msg_vpn_queue_subscription.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_queue_subscription Data Source - solacebroker" subcategory: "" description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_name|x - subscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,13 +13,6 @@ description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_name|x -subscription_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_queue_template.md b/docs/data-sources/msg_vpn_queue_template.md index 9f4e07b6..a88e279c 100644 --- a/docs/data-sources/msg_vpn_queue_template.md +++ b/docs/data-sources/msg_vpn_queue_template.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_queue_template Data Source - solacebroker" subcategory: "" description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_template_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -17,12 +13,6 @@ description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_template_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -73,7 +63,7 @@ This has been available since SEMP API version 2.14. "modify-topic" - Consume messages or modify the topic/selector. "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. -- `queue_name_filter` (String) A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `queue_name_filter` (String) A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `redelivery_delay_enabled` (Boolean) Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.33. - `redelivery_delay_initial_interval` (Number) The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since SEMP API version 2.33. - `redelivery_delay_max_interval` (Number) The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since SEMP API version 2.33. diff --git a/docs/data-sources/msg_vpn_replay_log.md b/docs/data-sources/msg_vpn_replay_log.md index 6999ee53..bcc8caa6 100644 --- a/docs/data-sources/msg_vpn_replay_log.md +++ b/docs/data-sources/msg_vpn_replay_log.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_replay_log Data Source - solacebroker" subcategory: "" description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - replay_log_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.10. --- @@ -17,12 +13,6 @@ description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -replay_log_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md b/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md index 3675a49c..4ce810c5 100644 --- a/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md +++ b/docs/data-sources/msg_vpn_replay_log_topic_filter_subscription.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_replay_log_topic_filter_subscription Data Sour subcategory: "" description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - replay_log_name|x - topic_filter_subscription|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. --- @@ -18,13 +13,6 @@ description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -replay_log_name|x -topic_filter_subscription|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_replicated_topic.md b/docs/data-sources/msg_vpn_replicated_topic.md index e4e0cac4..b3894814 100644 --- a/docs/data-sources/msg_vpn_replicated_topic.md +++ b/docs/data-sources/msg_vpn_replicated_topic.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_replicated_topic Data Source - solacebroker" subcategory: "" description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - replicated_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -17,12 +13,6 @@ description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -replicated_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_rest_delivery_point.md b/docs/data-sources/msg_vpn_rest_delivery_point.md index fafe6f8f..ad0e2b01 100644 --- a/docs/data-sources/msg_vpn_rest_delivery_point.md +++ b/docs/data-sources/msg_vpn_rest_delivery_point.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point Data Source - solacebroker subcategory: "" description: |- A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,12 +13,6 @@ description: |- A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md index 36e2f790..d0b5efea 100644 --- a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md +++ b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding Data Source subcategory: "" description: |- A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_binding_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -18,13 +13,6 @@ description: |- A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_binding_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md index 6d62f965..96f40bcc 100644 --- a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md +++ b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md @@ -4,13 +4,6 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_protected_re subcategory: "" description: |- A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - header_name|x|| - header_value||x|x - msg_vpn_name|x|| - queue_binding_name|x|| - rest_delivery_point_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.30. --- @@ -20,15 +13,6 @@ description: |- A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -header_name|x|| -header_value||x|x -msg_vpn_name|x|| -queue_binding_name|x|| -rest_delivery_point_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md index 29c0430d..c768857f 100644 --- a/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md +++ b/docs/data-sources/msg_vpn_rest_delivery_point_queue_binding_request_header.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_head subcategory: "" description: |- A request header to be added to the HTTP request. - Attribute|Identifying - :---|:---: - header_name|x - msg_vpn_name|x - queue_binding_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.23. --- @@ -19,14 +13,6 @@ description: |- A request header to be added to the HTTP request. -Attribute|Identifying -:---|:---: -header_name|x -msg_vpn_name|x -queue_binding_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md index c40446f2..c0e4d5f0 100644 --- a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md +++ b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer.md @@ -4,18 +4,6 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer Data Source subcategory: "" description: |- REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_aws_secret_access_key||x|x - authentication_client_cert_content||x|x - authentication_client_cert_password||x| - authentication_http_basic_password||x|x - authentication_http_header_value||x|x - authentication_oauth_client_secret||x|x - authentication_oauth_jwt_secret_key||x|x - msg_vpn_name|x|| - rest_consumer_name|x|| - rest_delivery_point_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -25,20 +13,6 @@ description: |- REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_aws_secret_access_key||x|x -authentication_client_cert_content||x|x -authentication_client_cert_password||x| -authentication_http_basic_password||x|x -authentication_http_header_value||x|x -authentication_oauth_client_secret||x|x -authentication_oauth_jwt_secret_key||x|x -msg_vpn_name|x|| -rest_consumer_name|x|| -rest_delivery_point_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md index 1f5b6746..7849471c 100644 --- a/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md +++ b/docs/data-sources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md @@ -4,12 +4,6 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_cl subcategory: "" description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - oauth_jwt_claim_name|x - rest_consumer_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.21. --- @@ -19,14 +13,6 @@ description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -oauth_jwt_claim_name|x -rest_consumer_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_sequenced_topic.md b/docs/data-sources/msg_vpn_sequenced_topic.md index 451b9210..ba10b000 100644 --- a/docs/data-sources/msg_vpn_sequenced_topic.md +++ b/docs/data-sources/msg_vpn_sequenced_topic.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_sequenced_topic Data Source - solacebroker" subcategory: "" description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - sequenced_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. --- @@ -17,12 +13,6 @@ description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -sequenced_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_telemetry_profile.md b/docs/data-sources/msg_vpn_telemetry_profile.md index f07e7a21..8e2d3549 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile.md +++ b/docs/data-sources/msg_vpn_telemetry_profile.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_telemetry_profile Data Source - solacebroker" subcategory: "" description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - telemetry_profile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -17,12 +13,6 @@ description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -telemetry_profile_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md b/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md index 50538503..dcff6c2e 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md +++ b/docs/data-sources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_receiver_acl_connect_excepti subcategory: "" description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - receiver_acl_connect_exception_address|x - telemetry_profile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -18,13 +13,6 @@ description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -receiver_acl_connect_exception_address|x -telemetry_profile_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md index ba7b46c6..3c000826 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md +++ b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter.md @@ -4,11 +4,6 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter Data Source - s subcategory: "" description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - telemetry_profile_name|x - trace_filter_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -18,13 +13,6 @@ description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -telemetry_profile_name|x -trace_filter_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md index e294c5be..d3e9871e 100644 --- a/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md +++ b/docs/data-sources/msg_vpn_telemetry_profile_trace_filter_subscription.md @@ -4,13 +4,6 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter_subscription Da subcategory: "" description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - subscription|x - subscription_syntax|x - telemetry_profile_name|x - trace_filter_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. --- @@ -20,15 +13,6 @@ description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -subscription|x -subscription_syntax|x -telemetry_profile_name|x -trace_filter_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_topic_endpoint.md b/docs/data-sources/msg_vpn_topic_endpoint.md index 02e9b7c0..a5143395 100644 --- a/docs/data-sources/msg_vpn_topic_endpoint.md +++ b/docs/data-sources/msg_vpn_topic_endpoint.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_topic_endpoint Data Source - solacebroker" subcategory: "" description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - topic_endpoint_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. --- @@ -17,12 +13,6 @@ description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -topic_endpoint_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. diff --git a/docs/data-sources/msg_vpn_topic_endpoint_template.md b/docs/data-sources/msg_vpn_topic_endpoint_template.md index 2d8206b4..2fc9823e 100644 --- a/docs/data-sources/msg_vpn_topic_endpoint_template.md +++ b/docs/data-sources/msg_vpn_topic_endpoint_template.md @@ -4,10 +4,6 @@ page_title: "solacebroker_msg_vpn_topic_endpoint_template Data Source - solacebr subcategory: "" description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - topic_endpoint_template_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. --- @@ -17,12 +13,6 @@ description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -topic_endpoint_template_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. @@ -83,7 +73,7 @@ This has been available since SEMP API version 2.14. - `respect_msg_priority_enabled` (Boolean) Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `respect_ttl_enabled` (Boolean) Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `topic_endpoint_name_filter` (String) A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `topic_endpoint_name_filter` (String) A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. ### Nested Schema for `event_bind_count_threshold` diff --git a/docs/data-sources/oauth_profile.md b/docs/data-sources/oauth_profile.md index e70be17f..b57aa4c7 100644 --- a/docs/data-sources/oauth_profile.md +++ b/docs/data-sources/oauth_profile.md @@ -3,24 +3,17 @@ page_title: "solacebroker_oauth_profile Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - client_secret||x|x - oauth_profile_name|x|| A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile (Data Source) -OAuth profiles specify how to securely authenticate to an OAuth provider. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -client_secret||x|x -oauth_profile_name|x|| +OAuth profiles specify how to securely authenticate to an OAuth provider. @@ -90,6 +83,7 @@ This has been available since SEMP API version 2.24. "client" - The broker is in the OAuth client role. "resource-server" - The broker is in the OAuth resource server role. +- `proxy_name` (String) The name of the proxy to use for discovery, user info, jwks, and introspection requests. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. Available since SEMP API version 2.41. - `resource_server_parse_access_token_enabled` (Boolean) Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `resource_server_required_audience` (String) The required audience value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `resource_server_required_issuer` (String) The required issuer value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. diff --git a/docs/data-sources/oauth_profile_access_level_group.md b/docs/data-sources/oauth_profile_access_level_group.md index b8dc260b..3e72eec3 100644 --- a/docs/data-sources/oauth_profile_access_level_group.md +++ b/docs/data-sources/oauth_profile_access_level_group.md @@ -3,24 +3,17 @@ page_title: "solacebroker_oauth_profile_access_level_group Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - Attribute|Identifying - :---|:---: - group_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile_access_level_group (Data Source) -The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -group_name|x -oauth_profile_name|x +The name of a group as it exists on the OAuth server being used to authenticate SEMP users. diff --git a/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md b/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md index d0d805d4..bf44a547 100644 --- a/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md +++ b/docs/data-sources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md @@ -3,26 +3,17 @@ page_title: "solacebroker_oauth_profile_access_level_group_msg_vpn_access_level_exception Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Message VPN access-level exceptions for members of this group. - Attribute|Identifying - :---|:---: - group_name|x - msg_vpn_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile_access_level_group_msg_vpn_access_level_exception (Data Source) -Message VPN access-level exceptions for members of this group. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -group_name|x -msg_vpn_name|x -oauth_profile_name|x +Message VPN access-level exceptions for members of this group. diff --git a/docs/data-sources/oauth_profile_client_allowed_host.md b/docs/data-sources/oauth_profile_client_allowed_host.md index fbdf89a6..45413a00 100644 --- a/docs/data-sources/oauth_profile_client_allowed_host.md +++ b/docs/data-sources/oauth_profile_client_allowed_host.md @@ -3,24 +3,17 @@ page_title: "solacebroker_oauth_profile_client_allowed_host Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. A valid hostname for this broker in OAuth redirects. - Attribute|Identifying - :---|:---: - allowed_host|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile_client_allowed_host (Data Source) -A valid hostname for this broker in OAuth redirects. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -allowed_host|x -oauth_profile_name|x +A valid hostname for this broker in OAuth redirects. diff --git a/docs/data-sources/oauth_profile_client_authorization_parameter.md b/docs/data-sources/oauth_profile_client_authorization_parameter.md index ae90d042..bd0877c0 100644 --- a/docs/data-sources/oauth_profile_client_authorization_parameter.md +++ b/docs/data-sources/oauth_profile_client_authorization_parameter.md @@ -3,24 +3,17 @@ page_title: "solacebroker_oauth_profile_client_authorization_parameter Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Additional parameters to be passed to the OAuth authorization endpoint. - Attribute|Identifying - :---|:---: - authorization_parameter_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile_client_authorization_parameter (Data Source) -Additional parameters to be passed to the OAuth authorization endpoint. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -authorization_parameter_name|x -oauth_profile_name|x +Additional parameters to be passed to the OAuth authorization endpoint. diff --git a/docs/data-sources/oauth_profile_client_required_claim.md b/docs/data-sources/oauth_profile_client_required_claim.md index 41c49241..8387d0cf 100644 --- a/docs/data-sources/oauth_profile_client_required_claim.md +++ b/docs/data-sources/oauth_profile_client_required_claim.md @@ -3,24 +3,17 @@ page_title: "solacebroker_oauth_profile_client_required_claim Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Additional claims to be verified in the ID token. - Attribute|Identifying - :---|:---: - client_required_claim_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile_client_required_claim (Data Source) -Additional claims to be verified in the ID token. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -client_required_claim_name|x -oauth_profile_name|x +Additional claims to be verified in the ID token. diff --git a/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md b/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md index 771542f7..1ddf90e8 100644 --- a/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md +++ b/docs/data-sources/oauth_profile_default_msg_vpn_access_level_exception.md @@ -3,24 +3,17 @@ page_title: "solacebroker_oauth_profile_default_msg_vpn_access_level_exception Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Default message VPN access-level exceptions. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile_default_msg_vpn_access_level_exception (Data Source) -Default message VPN access-level exceptions. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -msg_vpn_name|x -oauth_profile_name|x +Default message VPN access-level exceptions. diff --git a/docs/data-sources/oauth_profile_resource_server_required_claim.md b/docs/data-sources/oauth_profile_resource_server_required_claim.md index f4b76f64..4fe144b7 100644 --- a/docs/data-sources/oauth_profile_resource_server_required_claim.md +++ b/docs/data-sources/oauth_profile_resource_server_required_claim.md @@ -3,24 +3,17 @@ page_title: "solacebroker_oauth_profile_resource_server_required_claim Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Additional claims to be verified in the access token. - Attribute|Identifying - :---|:---: - oauth_profile_name|x - resource_server_required_claim_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. --- # solacebroker_oauth_profile_resource_server_required_claim (Data Source) -Additional claims to be verified in the access token. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -oauth_profile_name|x -resource_server_required_claim_name|x +Additional claims to be verified in the access token. diff --git a/docs/data-sources/proxy.md b/docs/data-sources/proxy.md new file mode 100644 index 00000000..fd7ebab9 --- /dev/null +++ b/docs/data-sources/proxy.md @@ -0,0 +1,50 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "solacebroker_proxy Data Source - solacebroker" +subcategory: "" +description: |- + This resource is not supported in production by Solace in this version, see provider limitations. + proxy 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. + A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. + This has been available since SEMP API version 2.41. +--- + +# solacebroker_proxy (Data Source) + +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). + +proxy 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. + + + +A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. + +This has been available since SEMP API version 2.41. + + + + +## Schema + +### Required + +- `proxy_name` (String) The name of the proxy. + +### Read-Only + +- `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: + +
+"none" - No authentication.
+"basic" - Username/password authentication.
+
+- `enabled` (Boolean) Enable or disable the proxy. When disabled, no connections are initiated to this particular proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. +- `host` (String) The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. +- `port` (Number) The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. +- `proxy_type` (String) The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"direct"`. The allowed values and their meaning are: + +
+"direct" - Direct connection (no proxy).
+"http" - HTTP proxy.
+
diff --git a/docs/data-sources/virtual_hostname.md b/docs/data-sources/virtual_hostname.md index 380c6ba2..a0d09d19 100644 --- a/docs/data-sources/virtual_hostname.md +++ b/docs/data-sources/virtual_hostname.md @@ -3,18 +3,18 @@ page_title: "solacebroker_virtual_hostname Data Source - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - Attribute|Identifying - :---|:---: - virtual_hostname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.17. --- # solacebroker_virtual_hostname (Data Source) +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). + A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. @@ -22,11 +22,6 @@ Clients which connect to a global (as opposed to per Message VPN) port and provi This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. -Attribute|Identifying -:---|:---: -virtual_hostname|x - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. diff --git a/docs/guides/config-generator.md b/docs/guides/config-generator.md index 5abfbe65..d153d74b 100644 --- a/docs/guides/config-generator.md +++ b/docs/guides/config-generator.md @@ -4,31 +4,32 @@ page_title: "Command-line Terraform Configuration Generator Guide" # Command-Line Terraform Configuration Generator -Normally, provider binaries are not run standalone, they are started and their services are used by Terraform CLI. +Normally, provider binaries are not run standalone, they are started, and their services are used by Terraform CLI. The `solacebroker` provider, however, includes an additional feature where you can run its binary outside of Terraform CLI. In this case, you can use the "generate" command on the provider binary to generate a Terraform HCL configuration file for a specified object and all its child objects known to the provider. You can [locate](https://terra-farm.github.io/main/installation.html) the provider binary in the `.terraform/providers` directory of an existing Terraform configuration directory that uses the `solacebroker` provider. -## Important notes +## Important Reminders and Tips You should review the generated configuration for the following: -* The provider block values in the generated configuration (URL, username, etc.) are exposed via Terraform input variables. Some write-only and related attribute values may also be assigned from input variables. It is recommended to check the variables created by the generator: you will need to assign value to those variables when applying the configuration or Terraform will prompt for the variable value. -* Some optional write-only attributes that cannot be determined by the generator if they were configured, are omitted from the generated configuration. You may need to add them manually. +* The provider block values in the generated configuration (URL, username, etc.) are exposed via Terraform input variables. Certain write-only and related attribute values may also be assigned from input variables. We recommend that you check the variables created by the generator: you will need to assign value to those variables when applying the configuration or Terraform will prompt for the variable value. +* Certain optional write-only attributes may not be included in the generated configuration if the generator cannot determine if they were configured. You may need to manually add these attributes. * Default resources may be present that you can omit. -* It may be required to add a "depends_on" meta-argument between generated objects. Refer to the "System provisioned objects" section. +* You my need to add a "depends_on" meta-argument between generated objects. For details, see the "System Provisioned Objects" section. * The generator uses a naming scheme for the resources. You can update this by manually replacing the generated names. ## Usage ` generate [flags] ` -* `` is the broker provider binary. +* `` is the event broker provider binary. * `[flags]` are the [supported parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/guides/config-generator#supported-parameters), which mirror the [configuration options for the provider object](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema), for example `--url=https://localhost:1943`. Parameters can alternatively be set via environment variables, for this example through setting `SOLACEBROKER_URL`. * `` is the address of the specified object instance in the generated configuration, in the form of `.` (for example `solacebroker_msg_vpn.myvpn`). * `` is the import identifier of the specified object instance as in the Terraform Import command. The import identifier is available from the documentation of each resource type. * `` is the name of the generated file. + This generator supports obtaining the configuration of software event brokers and will fail if applied against an appliance. This check may be overridden by setting the SOLACEBROKER_SKIP_API_CHECK=true environment variable. Example: @@ -36,13 +37,13 @@ Example: SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=admin terraform-provider-solacebroker generate --url=https://localhost:8080 solacebroker_msg_vpn_queue.q default/test my-message-vpn-queue.tf ``` -This will generate the configuration for queue `test` in message VPN `default`, and the configuration of all children, for example all subscriptions that have been configured to this queue. +This command generates the configuration for queue `test` in Message VPN `default`, and the configuration of all children, for example all subscriptions that have been configured for this queue. -### Supported parameters +### Supported Parameters The following parameters can be set as flags or environment variables (flags take precedence if both defined): -| Parameter | Required | Flag | Env var | Default | +| Parameter | Required | Flag | Environment Variable | Default | |------------------------------- |-----------|-----------------------|------------------------------|---------| | url | Yes | --url | SOLACEBROKER_URL | None | | username (Note1) | Yes | --username | SOLACEBROKER_USERNAME | None | @@ -58,19 +59,19 @@ The following parameters can be set as flags or environment variables (flags tak Note1: Only one authentication method can be used at a time: either bearer-token or username/password. -## Attribute generation +## Attribute Generation For each object, all attributes will be generated as attributes on the corresponding resource with the exception of: -* attributes that are at the default value (as per the broker version corresponding to the broker provider) +* attributes that are at the default value (as per the event broker version corresponding to the event broker provider) * write-only attributes that cannot be determined if they were configured (not coupled with another non write-only attribute) Write-only attributes that are coupled with another non write-only attribute will be generated as variable references. Variables for coupled attributes that are not write-only will have a commented-out default value with the value of the attribute, which you can choose to uncomment. Having no default means that Terraform will prompt for the variable value. -## System provisioned objects +## System Provisioned Objects -System provisioned broker objects are created as a side-effect of creating other objects. These other objects are referred to as "parent object". The generator is attempting to recognize system provisioned objects and omit them from the configuration or add a warning comment, as direct creation of such objects will fail. +System provisioned event broker objects are created as a side-effect of creating other objects. These other objects are referred to as "parent objects". The generator is attempting to recognize system provisioned objects and omit them from the configuration or add a warning comment, as direct creation of such objects will fail. -If an object's attribute is referencing a possible system-provisioned object, there may be a conflict at apply-time if the referenced object has not yet been created. The generator will add a comment when recognizing such references and it may be necessary to add a "depends_on" meta-argument between the referencoing and the parent objects to ensure proper create sequence. +If an object's attribute is referencing a possible system-provisioned object, there may be a conflict at apply-time if the referenced object has not yet been created. The generator will also add a comment when recognizing such possible references and it may be necessary to add a "create first" relationship using the Terraform "depends_on" meta-argument from the referencing resource to the system-provisioned object's parent resource to ensure proper create sequence. ## Troubleshooting @@ -78,13 +79,13 @@ The following issues may arise while using the generator. | Error | SEMP call failed. unexpected status 401 (401 Unauthorized) | |-----------------|----------------------------------------------------------------------------| -| Explanation | Configurations to connect to the PubSub+ broker not accurate. | -| Possible Action | Check and confirm, configuration details to PubSub+ broker are accurate. | +| Explanation | This indicates that the configuration details used to connect to the PubSub+ event broker are not accurate. | +| Possible Action | Verify that the configuration details used to connect to the PubSub+ event broker are accurate. | | Error | SOLACEBROKER_xxx is mandatory but not available | |-----------------|------------------------------------------------------------------------------------| -| Explanation | A mandatory parameter which is required to connect to PubSub+ broker is missing. | -| Possible Action | Confirm if all [mandatory parameters](#supported-options) are correctly set. | +| Explanation | This indicates that a mandatory parameter which is required to connect to the PubSub+ event broker is missing. | +| Possible Action | Verify that all [mandatory parameters](#supported-options) are correctly set. | | Error | Error: Too many provider specific identifiers. Required identifiers: [{xxx}] | |-----------------|------------------------------------------------------------------------------| @@ -94,7 +95,7 @@ The following issues may arise while using the generator. | Error | SEMP called failed. resource not found on path /xxx/xxx | |-----------------|------------------------------------------------------------------------------------------| | Explanation | This indicates the resource attributes attempted to be fetched could not be read. | -| Possible Action | Ensure identifiers values are consistent as set on the PubSub+ broker configured with. | +| Possible Action | Ensure identifiers values are consistent as set on the PubSub+ event broker configured with. | | Error | Error: Broker resource not found by terraform name xxx | |-----------------|------------------------------------------------------------------------------------------------------------| @@ -103,5 +104,5 @@ The following issues may arise while using the generator. | Error | Error: Broker check failed | |-----------------|-------------------------------------------------------------------------------------------------------------| -| Explanation | This indicates that broker platform does not match provider supported platform | -| Possible Action | Ensure that an appliance provider is used against a software broker platform and not an appliance platform. | +| Explanation | This indicates that the specified event broker platform is not supported by the provider | +| Possible Action | Ensure that a software broker provider binary is used against a software broker platform and not an appliance platform. | diff --git a/docs/guides/provider.md b/docs/guides/provider.md index a86fe4e0..df1a4ab8 100644 --- a/docs/guides/provider.md +++ b/docs/guides/provider.md @@ -12,21 +12,21 @@ This provider supports configuring software event brokers and will fail if appli ## Mapping of SEMP API and Provider Names -Terraform uses the [snake case](https://en.wikipedia.org/wiki/Snake_case) naming scheme, while SEMP uses camel case. Resources and datasource are also prefixed with the provider local name, `solacebroker_`. For example, `solacebroker_msg_vpn` is the message-vpn resource name and `max_subscription_count` is the attribute for the maximum subscription count, since `MsgVpn` is the SEMP API object name and `maxSubscriptionCount` is the name of the SEMP attribute. +Terraform uses the [snake case](https://en.wikipedia.org/wiki/Snake_case) naming scheme, while SEMP uses camel case. Resources and datasource are also prefixed with the provider local name, `solacebroker_`. For example, `solacebroker_msg_vpn` is the Message VPN resource name and `max_subscription_count` is the attribute for the maximum subscription count, since `MsgVpn` is the SEMP API object name and `maxSubscriptionCount` is the name of the SEMP attribute. -## Broker SEMP API Access +## Event Broker SEMP API Access The broker SEMP service, by default at port 8080 for HTTP and TLS port 1943 for HTTPS, must be accessible to the console running Terraform CLI. -The supported access credentials are basic authentication using username and password, and OAuth using a token. The two options are mutually exclusive and the provider will fail if both are configured. +The supported access credentials are basic authentication using username and password, and OAuth using a token. The two options are mutually exclusive, and the provider will fail if both are configured. -> The [user access levels](https://docs.solace.com/Admin/CLI-User-Access-Levels.htm) associated with the credentials used must be properly configured on the broker so that the desired actions are authorized. -## SEMP API Versioning and Provider Broker Compatibility +## SEMP API Versioning and Provider Event Broker Compatibility The SEMP API minor version reflects the supported set of objects, attributes, their properties and possible deprecations. -New versions of the PubSub+ event broker with new features typically require a newer SEMP API version that supports the new or updated objects, attributes, etc. The SEMP API version of a broker version can be determined from the [Solace PubSub+ documentation](https://docs.solace.com/Admin/SEMP/SEMP-API-Versions.htm#SEMP_v2_to_SolOS_Version_Mapping). +New versions of the PubSub+ event broker with new features typically require a newer SEMP API version that supports the new or updated objects, attributes, etc. The SEMP API version of an event broker version can be determined from the [Solace PubSub+ documentation](https://docs.solace.com/Admin/SEMP/SEMP-API-Versions.htm#SEMP_v2_to_SolOS_Version_Mapping). A given version of the provider is built to support a specific version of the SEMP API. For the SEMP API version of the provider and corresponding broker version, refer to the [Version Compatibility section](https://docs.solace.com/Admin/SEMP/Declarative-SEMP.htm#Version) of the Solace PubSub+ documentation. @@ -36,7 +36,7 @@ A given version of the provider is built to support a specific version of the SE ## Object Relationships -Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "Identifying" attributes that give a hint to required pre-existing objects. +Event Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "required" attributes that give a hint to required pre-existing objects. For example: ```terraform @@ -64,28 +64,47 @@ The Broker object differs from all other objects as it always exists for a given ## Default Objects -There are objects that are preexisting defaults and cannot be created or destroyed, only updated. The default Message VPN and the default client profile are examples of this. Any attempt to remove these resources will fail. +There are objects that are preexisting defaults and cannot be created or destroyed, only updated. The default Message VPN and the default client profile are examples of this. Any direct attempt to remove these resources will fail. If the parent object is not a default object then deleting that parent will also remove its child default object. + +> If, for example, a configuration includes creating a non-default Message VPN and modifying its default client profile, then when destroying the configuration the provider would report an error about removing the client profile. However, the client profile object will be eventually deleted because the whole Message VPN will also be deleted, which includes the default client profile. ## Broker-Defined Attributes -Some attributes don't have a default value. In this case their value will be determined by the broker. Typically, these defaults depend on the broker scaling settings. While Terraform plan and apply operations function the same way as with other attributes, import will set the Terraform state of the attribute to the broker value (instead of null), even if they were set at default. You can use subsequent plan and apply operations to fix this. +Some attributes don't have a default value. In this case their value will be determined by the broker. Typically, these defaults depend on the broker scaling settings. While Terraform plan and apply operations function the same way as with other attributes, import will set the Terraform state of the attribute to the broker value (instead of null), even if they were set at default. You can use subsequent plan and apply operations to fix this. + +## Object Type Attributes + +An object type attribute is a collection of attributes, for example `"event_ingress_msg_rate_threshold": { "clear_value": 2000000, "set_value": 5000000 }`. Note that due to Terraform provider framework limitations, there is no error reported when configuring unknown nested attributes in object type attributes. + +## Resource Replace Behavior + +In-place update of some resources is not possible at configuration change and instead the resource will be replaced for the change to occur. + +Generally, changing a "required" attribute requires the replace of any resource because the changed attribute will identify a new resource. Optional attributes that are marked as "requires-replacement" in the [provider resources documentation](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs) also cause replace of the resource. + +> Important: If a resource is replaced because of a change, its child resources will be deleted and not automatically restored. Running `terraform plan` after the resource has been replaced will reveal the missing child objects to be restored and a subsequent `terraform apply` will be required to restore those child resources. For example, changing the `direct_only_enabled` attribute of the `dmr_cluster` resource will delete all child resources such as `dmr_cluster_link`. ## Importing Resources -When [importing resources to Terraform](https://developer.hashicorp.com/terraform/language/import#syntax) an `id` is required. This `id` shall be constructed as a path from the highest parent object down to the resource. +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. -For example, when importing a `solacebroker_msg_vpn_queue_subscription`, the parent relationship is `msg_vpn` > `msg_vpn_queue` > `msg_vpn_queue_subscription`. To construct the `id`, concatenate the identifications of parents and the particular resource identification, separated by `/` (slash). Also note that elements containing `/` must be URL-encoded. +We recommend using the following procedure to import a resource: -For this example: -``` -id = // -# using my-vpn, my-queue, a/b/c -id = my-vpn/my-queue/a%2Fb%2Fc -``` +1. Add the desired resource block with the type and a name for the required resource to the Terraform config file. At a minimum, provide the required attributes. The list of required attributes is available from the resource documentation. Alternatively, you can get most attributes for the required resource (except for sensitive ones) from using the [configuration generator](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/guides/config-generator). +1. Use the `terraform import` command to get the resource to the state file. +1. Test the new resource by running `terraform plan`. If all the non-default attributes were added correctly it should show no need to update. If there is any diff, then the indicated attributes should be updated until the plan shows no change. + +> Note: Terraform import will only write actual values to the state file for attributes that are set to a non-default value. The value of attributes with default value will be imported as `null`. + +## PubSub+ Cloud Notes + +* Applying a Message VPN resource configuration to a PubSub+ Cloud broker may cause issues with attributes that are not authorized to be set in PubSub+ Cloud. This can be resolved by removing or commenting out the attributes in the configuration that are reported to be conflicting with the authorization access level. +* Similarly, attempting to delete the configuration of a Message VPN using `terraform destroy` is also expected to fail because of the insufficient authorization access level of the PubSub+ Cloud user. -## Notes +## Notes and Limitations * Terraform `apply` is not atomic. If interrupted by a user, failure, reboot, or switchover the configuration changes may be partly applied. Terraform does not perform rollbacks. * Terraform must be the authoritative source of configuration. If there is any overlap between Terraform controlled configuration and either pre-existing configuration or modifications from other management interfaces the behaviour will be undefined. * Apply operations may impact broker AD performance, especially large changes. The `request_min_interval` attribute on the provider limits the request rate and can be adjusted to control the impact. -* Application of configuration may cause brief service interruptions to the resources affected. These can include a queue missing a published message or clients being briefly disconnected. These outages are no different from a current administrator manually making an equivalent change to a broker. \ No newline at end of file +* Application of configuration may cause brief service interruptions to the resources affected. These can include a queue missing a published message or clients being briefly disconnected. These outages are no different from a current administrator manually making an equivalent change to a broker. +* Avoid creating multiple resource blocks for the same resource (where all identifying attributes are the same) as this can result in issues: the same broker resource will be present in the state under multiple different Terraform resource names and removing a resource block may cause the resource to be deleted on the broker, while the other resource name in the state still refers to that resource. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 6d1d4f5f..35b81bb4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,6 +22,10 @@ This provider also offers the possibility to generate an [HCL configuration](htt Use the navigation to the left for more information in the guides and for the available provider resources and data sources. +## Limitations + +> This version of the PubSub+ Terraform provider is generally available for production services contained within a Message VPN. Use of any resource not contained within a Message VPN is not supported in production by Solace. + ## Minimum broker version The minimum required PubSub+ Software Event Broker version is 10.4. @@ -85,4 +89,4 @@ For example, the password attribute can be set via the `SOLACEBROKER_PASSWORD` e # Release Notes and History -For detailed release notes and release history, refer to the Releases section in the [Provider GitHub repository](https://github.com/SolaceProducts/terraform-provider-solacebrokerappliance/releases). +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/docs/resources/broker.md b/docs/resources/broker.md index a6ba8a91..032781d0 100644 --- a/docs/resources/broker.md +++ b/docs/resources/broker.md @@ -3,14 +3,12 @@ page_title: "solacebroker_broker Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. This object contains global configuration for the message broker. - Attribute|Write-Only|Opaque - :---|:---:|:---: - tls_server_cert_content|x|x - tls_server_cert_password|x| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than "vpn/read-only": Attribute|Access Scope/Level :---|:---: + auth_brute_force_protection_enabled|global/read-only auth_client_cert_revocation_check_mode|global/read-only config_sync_authentication_client_cert_max_chain_depth|global/read-only config_sync_authentication_client_cert_validate_date_enabled|global/read-only @@ -135,13 +133,9 @@ description: |- # solacebroker_broker (Resource) -This object contains global configuration for the message broker. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Write-Only|Opaque -:---|:---:|:---: -tls_server_cert_content|x|x -tls_server_cert_password|x| +This object contains global configuration for the message broker. @@ -150,6 +144,7 @@ A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is Attribute|Access Scope/Level :---|:---: +auth_brute_force_protection_enabled|global/read-only auth_client_cert_revocation_check_mode|global/read-only config_sync_authentication_client_cert_max_chain_depth|global/read-only config_sync_authentication_client_cert_validate_date_enabled|global/read-only @@ -282,6 +277,7 @@ The import identifier for this resource is `""` (empty string) ### Optional +- `auth_brute_force_protection_enabled` (Boolean) Enable or disable protection against brute force password guessing attacks on local management accounts. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since SEMP API version 2.40. - `auth_client_cert_revocation_check_mode` (String) The client certificate revocation checking mode used when a client authenticates with a client certificate. 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/client_cert_authority.md b/docs/resources/client_cert_authority.md
index 8b8ed46b..44ab79a6 100644
--- a/docs/resources/client_cert_authority.md
+++ b/docs/resources/client_cert_authority.md
@@ -3,23 +3,18 @@
 page_title: "solacebroker_client_cert_authority Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.
-  Attribute|Identifying
-  :---|:---:
-  cert_authority_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.19.
-  The import identifier for this resource is {certAuthorityName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {cert_authority_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_client_cert_authority (Resource)
 
-Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-cert_authority_name|x
+Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.
 
 
 
@@ -27,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.19.
 
-The import identifier for this resource is `{certAuthorityName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{cert_authority_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
diff --git a/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md b/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md
index 1657cfd1..b6b0882d 100644
--- a/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md
+++ b/docs/resources/client_cert_authority_ocsp_tls_trusted_common_name.md
@@ -3,25 +3,18 @@
 page_title: "solacebroker_client_cert_authority_ocsp_tls_trusted_common_name Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.
-  Attribute|Identifying
-  :---|:---:
-  cert_authority_name|x
-  ocsp_tls_trusted_common_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.19.
-  The import identifier for this resource is {certAuthorityName}/{ocspTlsTrustedCommonName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {cert_authority_name}/{ocsp_tls_trusted_common_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_client_cert_authority_ocsp_tls_trusted_common_name (Resource)
 
-When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-cert_authority_name|x
-ocsp_tls_trusted_common_name|x
+When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.
 
 
 
@@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.19.
 
-The import identifier for this resource is `{certAuthorityName}/{ocspTlsTrustedCommonName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{cert_authority_name}/{ocsp_tls_trusted_common_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
diff --git a/docs/resources/dmr_cluster.md b/docs/resources/dmr_cluster.md
index e95915fa..358b3a81 100644
--- a/docs/resources/dmr_cluster.md
+++ b/docs/resources/dmr_cluster.md
@@ -3,31 +3,18 @@
 page_title: "solacebroker_dmr_cluster Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authentication_basic_password||x||x
-  authentication_client_cert_content||x||x
-  authentication_client_cert_password||x||
-  dmr_cluster_name|x|||
-  tls_server_cert_enforce_trusted_common_name_enabled|||x|
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
-  The import identifier for this resource is {dmrClusterName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {dmr_cluster_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_dmr_cluster (Resource)
 
-A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_basic_password||x||x
-authentication_client_cert_content||x||x
-authentication_client_cert_password||x||
-dmr_cluster_name|x|||
-tls_server_cert_enforce_trusted_common_name_enabled|||x|
+A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.
 
 
 
@@ -35,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.11.
 
-The import identifier for this resource is `{dmrClusterName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{dmr_cluster_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
@@ -59,7 +46,7 @@ The import identifier for this resource is `{dmrClusterName}`, where {<attrib
 - `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_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 `""`.
-- `direct_only_enabled` (Boolean) Enable or disable direct messaging only. Guaranteed messages will not be transmitted through the cluster. The default value is `false`.
+- `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`.
 - `tls_server_cert_validate_date_enabled` (Boolean) Enable or disable the validation of the "Not Before" and "Not After" validity dates in the certificate. When disabled, the certificate is accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.
diff --git a/docs/resources/dmr_cluster_cert_matching_rule.md b/docs/resources/dmr_cluster_cert_matching_rule.md
index 45378bfc..00ec2464 100644
--- a/docs/resources/dmr_cluster_cert_matching_rule.md
+++ b/docs/resources/dmr_cluster_cert_matching_rule.md
@@ -3,25 +3,18 @@
 page_title: "solacebroker_dmr_cluster_cert_matching_rule Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  rule_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
-  The import identifier for this resource is {dmrClusterName}/{ruleName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {dmr_cluster_name}/{rule_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_dmr_cluster_cert_matching_rule (Resource)
 
-A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-rule_name|x
+A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.
 
 
 
@@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.28.
 
-The import identifier for this resource is `{dmrClusterName}/{ruleName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{dmr_cluster_name}/{rule_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
diff --git a/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md b/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md
index fb097de0..5e8945b8 100644
--- a/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md
+++ b/docs/resources/dmr_cluster_cert_matching_rule_attribute_filter.md
@@ -3,27 +3,18 @@
 page_title: "solacebroker_dmr_cluster_cert_matching_rule_attribute_filter Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cert Matching Rule Attribute Filter compares a link attribute to a string.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  filter_name|x
-  rule_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
-  The import identifier for this resource is {dmrClusterName}/{ruleName}/{filterName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {dmr_cluster_name}/{rule_name}/{filter_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_dmr_cluster_cert_matching_rule_attribute_filter (Resource)
 
-A Cert Matching Rule Attribute Filter compares a link attribute to a string.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-filter_name|x
-rule_name|x
+A Cert Matching Rule Attribute Filter compares a link attribute to a string.
 
 
 
@@ -31,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.28.
 
-The import identifier for this resource is `{dmrClusterName}/{ruleName}/{filterName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{dmr_cluster_name}/{rule_name}/{filter_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
diff --git a/docs/resources/dmr_cluster_cert_matching_rule_condition.md b/docs/resources/dmr_cluster_cert_matching_rule_condition.md
index 60230f79..799d2428 100644
--- a/docs/resources/dmr_cluster_cert_matching_rule_condition.md
+++ b/docs/resources/dmr_cluster_cert_matching_rule_condition.md
@@ -3,27 +3,18 @@
 page_title: "solacebroker_dmr_cluster_cert_matching_rule_condition Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  rule_name|x
-  source|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
-  The import identifier for this resource is {dmrClusterName}/{ruleName}/{source}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {dmr_cluster_name}/{rule_name}/{source}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_dmr_cluster_cert_matching_rule_condition (Resource)
 
-A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-rule_name|x
-source|x
+A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.
 
 
 
@@ -31,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.28.
 
-The import identifier for this resource is `{dmrClusterName}/{ruleName}/{source}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{dmr_cluster_name}/{rule_name}/{source}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
@@ -62,5 +53,5 @@ The import identifier for this resource is `{dmrClusterName}/{ruleName}/{source}
 
 ### Optional
 
-- `attribute` (String) Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`.
-- `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`.
+- `attribute` (String) Link Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`. Note that this attribute requires replacement of the resource when updated.
+- `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`. Note that this attribute requires replacement of the resource when updated.
diff --git a/docs/resources/dmr_cluster_link.md b/docs/resources/dmr_cluster_link.md
index 7e98838b..925eb317 100644
--- a/docs/resources/dmr_cluster_link.md
+++ b/docs/resources/dmr_cluster_link.md
@@ -3,27 +3,18 @@
 page_title: "solacebroker_dmr_cluster_link Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
-  Attribute|Identifying|Write-Only|Opaque
-  :---|:---:|:---:|:---:
-  authentication_basic_password||x|x
-  dmr_cluster_name|x||
-  remote_node_name|x||
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
-  The import identifier for this resource is {dmrClusterName}/{remoteNodeName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {dmr_cluster_name}/{remote_node_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_dmr_cluster_link (Resource)
 
-A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying|Write-Only|Opaque
-:---|:---:|:---:|:---:
-authentication_basic_password||x|x
-dmr_cluster_name|x||
-remote_node_name|x||
+A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.
 
 
 
@@ -31,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.11.
 
-The import identifier for this resource is `{dmrClusterName}/{remoteNodeName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{dmr_cluster_name}/{remote_node_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
@@ -68,6 +59,8 @@ The import identifier for this resource is `{dmrClusterName}/{remoteNodeName}`,
 - `client_profile_tcp_keepalive_interval` (Number) The amount of time between TCP keepalive retransmissions when no acknowledgment is received, in seconds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1`.
 - `client_profile_tcp_max_segment_size` (Number) The TCP maximum segment size, in bytes. Changes are applied to all existing connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1460`.
 - `client_profile_tcp_max_window_size` (Number) The TCP maximum window size, in kilobytes. Changes are applied to all existing connections. This setting is ignored on the software broker. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `256`.
+- `connection_retry_count` (Number) The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since SEMP API version 2.41.
+- `connection_retry_delay` (Number) The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. Available since SEMP API version 2.41.
 - `egress_flow_window_size` (Number) The number of outstanding guaranteed messages that can be sent over the Link before acknowledgment is received by the sender. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.
 - `enabled` (Boolean) Enable or disable the Link. When disabled, subscription sets of this and the remote node are not kept up-to-date, and messages are not exchanged with the remote node. Published guaranteed messages will be queued up for future delivery based on current subscription sets. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.
 - `initiator` (String) The initiator of the Link's TCP connections. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"lexical"`. The allowed values and their meaning are:
diff --git a/docs/resources/dmr_cluster_link_attribute.md b/docs/resources/dmr_cluster_link_attribute.md
index 8c427e91..ce6668e7 100644
--- a/docs/resources/dmr_cluster_link_attribute.md
+++ b/docs/resources/dmr_cluster_link_attribute.md
@@ -3,29 +3,18 @@
 page_title: "solacebroker_dmr_cluster_link_attribute Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
-  Attribute|Identifying
-  :---|:---:
-  attribute_name|x
-  attribute_value|x
-  dmr_cluster_name|x
-  remote_node_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.28.
-  The import identifier for this resource is {dmrClusterName}/{remoteNodeName}/{attributeName}/{attributeValue}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {dmr_cluster_name}/{remote_node_name}/{attribute_name}/{attribute_value}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_dmr_cluster_link_attribute (Resource)
 
-A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-attribute_name|x
-attribute_value|x
-dmr_cluster_name|x
-remote_node_name|x
+A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.
 
 
 
@@ -33,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.28.
 
-The import identifier for this resource is `{dmrClusterName}/{remoteNodeName}/{attributeName}/{attributeValue}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{dmr_cluster_name}/{remote_node_name}/{attribute_name}/{attribute_value}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
diff --git a/docs/resources/dmr_cluster_link_remote_address.md b/docs/resources/dmr_cluster_link_remote_address.md
index 730feb02..d140592c 100644
--- a/docs/resources/dmr_cluster_link_remote_address.md
+++ b/docs/resources/dmr_cluster_link_remote_address.md
@@ -3,27 +3,18 @@
 page_title: "solacebroker_dmr_cluster_link_remote_address Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
-  Attribute|Identifying
-  :---|:---:
-  dmr_cluster_name|x
-  remote_address|x
-  remote_node_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.11.
-  The import identifier for this resource is {dmrClusterName}/{remoteNodeName}/{remoteAddress}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {dmr_cluster_name}/{remote_node_name}/{remote_address}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_dmr_cluster_link_remote_address (Resource)
 
-Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-dmr_cluster_name|x
-remote_address|x
-remote_node_name|x
+Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.
 
 
 
@@ -31,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.11.
 
-The import identifier for this resource is `{dmrClusterName}/{remoteNodeName}/{remoteAddress}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{dmr_cluster_name}/{remote_node_name}/{remote_address}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
diff --git a/docs/resources/domain_cert_authority.md b/docs/resources/domain_cert_authority.md
index 60731d3f..02a1e8eb 100644
--- a/docs/resources/domain_cert_authority.md
+++ b/docs/resources/domain_cert_authority.md
@@ -3,23 +3,18 @@
 page_title: "solacebroker_domain_cert_authority Resource - solacebroker"
 subcategory: ""
 description: |-
+  This resource is not supported in production by Solace in this version, see provider limitations.
   Certificate Authorities trusted for domain verification.
-  Attribute|Identifying
-  :---|:---:
-  cert_authority_name|x
   A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.19.
-  The import identifier for this resource is {certAuthorityName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {cert_authority_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_domain_cert_authority (Resource)
 
-Certificate Authorities trusted for domain verification.
-
+> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).
 
-Attribute|Identifying
-:---|:---:
-cert_authority_name|x
+Certificate Authorities trusted for domain verification.
 
 
 
@@ -27,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only"
 
 This has been available since SEMP API version 2.19.
 
-The import identifier for this resource is `{certAuthorityName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{cert_authority_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
diff --git a/docs/resources/msg_vpn.md b/docs/resources/msg_vpn.md
index f1f54cb5..67e0cfa5 100644
--- a/docs/resources/msg_vpn.md
+++ b/docs/resources/msg_vpn.md
@@ -4,20 +4,9 @@ page_title: "solacebroker_msg_vpn Resource - solacebroker"
 subcategory: ""
 description: |-
   Message 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.
-  Attribute|Identifying|Write-Only|Deprecated|Opaque
-  :---|:---:|:---:|:---:|:---:
-  authentication_oauth_default_provider_name|||x|
-  bridging_tls_server_cert_enforce_trusted_common_name_enabled|||x|
-  distributed_cache_management_enabled|||x|
-  msg_vpn_name|x|||
-  replication_bridge_authentication_basic_password||x||x
-  replication_bridge_authentication_client_cert_content||x||x
-  replication_bridge_authentication_client_cert_password||x||
-  replication_enabled_queue_behavior||x||
-  rest_tls_server_cert_enforce_trusted_common_name_enabled|||x|
   A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
   This has been available since SEMP API version 2.0.
-  The import identifier for this resource is {msgVpnName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+  The import identifier for this resource is {msg_vpn_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 ---
 
 # solacebroker_msg_vpn (Resource)
@@ -25,25 +14,12 @@ description: |-
 Message 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.
 
 
-Attribute|Identifying|Write-Only|Deprecated|Opaque
-:---|:---:|:---:|:---:|:---:
-authentication_oauth_default_provider_name|||x|
-bridging_tls_server_cert_enforce_trusted_common_name_enabled|||x|
-distributed_cache_management_enabled|||x|
-msg_vpn_name|x|||
-replication_bridge_authentication_basic_password||x||x
-replication_bridge_authentication_client_cert_content||x||x
-replication_bridge_authentication_client_cert_password||x||
-replication_enabled_queue_behavior||x||
-rest_tls_server_cert_enforce_trusted_common_name_enabled|||x|
-
-
 
 A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation.
 
 This has been available since SEMP API version 2.0.
 
-The import identifier for this resource is `{msgVpnName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
+The import identifier for this resource is `{msg_vpn_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.
 
 
 
@@ -72,9 +48,9 @@ Changes to this attribute are synchronized to HA mates and replication sites via
 "radius" - RADIUS authentication. A RADIUS profile name must be provided.
 "none" - No authentication. Anonymous login allowed.
-- `authentication_client_cert_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_client_cert_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `authentication_client_cert_certificate_matching_rules_enabled` (Boolean) Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.27. -- `authentication_client_cert_enabled` (Boolean) Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_client_cert_enabled` (Boolean) Enable or disable client certificate authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `authentication_client_cert_max_chain_depth` (Number) The maximum depth for a client 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 and replication sites via config-sync. The default value is `3`. - `authentication_client_cert_revocation_check_mode` (String) The desired behavior for client certificate revocation checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"allow-valid"`. The allowed values and their meaning are: @@ -96,10 +72,10 @@ Changes to this attribute are synchronized to HA mates and replication sites via Available since SEMP API version 2.6. - `authentication_client_cert_validate_date_enabled` (Boolean) Enable or disable validation of the "Not Before" and "Not After" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. -- `authentication_kerberos_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `authentication_kerberos_enabled` (Boolean) Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_kerberos_allow_api_provided_username_enabled` (Boolean) Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `authentication_kerberos_enabled` (Boolean) Enable or disable Kerberos authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `authentication_oauth_default_profile_name` (String) The name of the profile to use when the client does not supply a profile 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.25. -- `authentication_oauth_enabled` (Boolean) Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13. +- `authentication_oauth_enabled` (Boolean) Enable or disable OAuth authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13. - `authorization_ldap_group_membership_attribute_name` (String) The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"memberOf"`. - `authorization_ldap_trim_client_username_domain_enabled` (Boolean) Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurrence of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13. - `authorization_profile_name` (String) The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. @@ -152,7 +128,7 @@ Changes to this attribute are synchronized to HA mates and replication sites via - `max_ingress_flow_count` (Number) The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. - `max_kafka_broker_connection_count` (Number) The maximum number of simultaneous Kafka broker connections of the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since SEMP API version 2.39. - `max_msg_spool_usage` (Number) The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. -- `max_subscription_count` (Number) The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. +- `max_subscription_count` (Number) The maximum number of local subscriptions that can be added to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500000`. - `max_transacted_session_count` (Number) The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - `max_transaction_count` (Number) The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform. - `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. diff --git a/docs/resources/msg_vpn_acl_profile.md b/docs/resources/msg_vpn_acl_profile.md index d79870e4..c2c11995 100644 --- a/docs/resources/msg_vpn_acl_profile.md +++ b/docs/resources/msg_vpn_acl_profile.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_acl_profile Resource - solacebroker" subcategory: "" description: |- An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{aclProfileName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{acl_profile_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_acl_profile (Resource) @@ -18,18 +14,12 @@ description: |- An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{aclProfileName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{acl_profile_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_acl_profile_client_connect_exception.md b/docs/resources/msg_vpn_acl_profile_client_connect_exception.md index 25f22c6f..d911ee32 100644 --- a/docs/resources/msg_vpn_acl_profile_client_connect_exception.md +++ b/docs/resources/msg_vpn_acl_profile_client_connect_exception.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_acl_profile_client_connect_exception Resource subcategory: "" description: |- A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. - Attribute|Identifying - :---|:---: - acl_profile_name|x - client_connect_exception_address|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{aclProfileName}/{clientConnectExceptionAddress}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{acl_profile_name}/{client_connect_exception_address}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_acl_profile_client_connect_exception (Resource) @@ -19,19 +14,12 @@ description: |- A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form. -Attribute|Identifying -:---|:---: -acl_profile_name|x -client_connect_exception_address|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{aclProfileName}/{clientConnectExceptionAddress}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{acl_profile_name}/{client_connect_exception_address}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md b/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md index bc093a52..46fb7532 100644 --- a/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md +++ b/docs/resources/msg_vpn_acl_profile_publish_topic_exception.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_acl_profile_publish_topic_exception Resource - subcategory: "" description: |- A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x - publish_topic_exception|x - publish_topic_exception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. - The import identifier for this resource is {msgVpnName}/{aclProfileName}/{publishTopicExceptionSyntax}/{publishTopicException}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{acl_profile_name}/{publish_topic_exception_syntax}/{publish_topic_exception}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_acl_profile_publish_topic_exception (Resource) @@ -20,20 +14,12 @@ description: |- A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x -publish_topic_exception|x -publish_topic_exception_syntax|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. -The import identifier for this resource is `{msgVpnName}/{aclProfileName}/{publishTopicExceptionSyntax}/{publishTopicException}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{acl_profile_name}/{publish_topic_exception_syntax}/{publish_topic_exception}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md b/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md index c5856d1b..53e90803 100644 --- a/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md +++ b/docs/resources/msg_vpn_acl_profile_subscribe_share_name_exception.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_share_name_exception Res subcategory: "" description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x - subscribe_share_name_exception|x - subscribe_share_name_exception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. - The import identifier for this resource is {msgVpnName}/{aclProfileName}/{subscribeShareNameExceptionSyntax}/{subscribeShareNameException}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{acl_profile_name}/{subscribe_share_name_exception_syntax}/{subscribe_share_name_exception}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_acl_profile_subscribe_share_name_exception (Resource) @@ -20,20 +14,12 @@ description: |- A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x -subscribe_share_name_exception|x -subscribe_share_name_exception_syntax|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. -The import identifier for this resource is `{msgVpnName}/{aclProfileName}/{subscribeShareNameExceptionSyntax}/{subscribeShareNameException}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{acl_profile_name}/{subscribe_share_name_exception_syntax}/{subscribe_share_name_exception}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md b/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md index 557d155d..8f94d57f 100644 --- a/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md +++ b/docs/resources/msg_vpn_acl_profile_subscribe_topic_exception.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_acl_profile_subscribe_topic_exception Resource subcategory: "" description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. - Attribute|Identifying - :---|:---: - acl_profile_name|x - msg_vpn_name|x - subscribe_topic_exception|x - subscribe_topic_exception_syntax|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. - The import identifier for this resource is {msgVpnName}/{aclProfileName}/{subscribeTopicExceptionSyntax}/{subscribeTopicException}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{acl_profile_name}/{subscribe_topic_exception_syntax}/{subscribe_topic_exception}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_acl_profile_subscribe_topic_exception (Resource) @@ -20,20 +14,12 @@ description: |- A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic. -Attribute|Identifying -:---|:---: -acl_profile_name|x -msg_vpn_name|x -subscribe_topic_exception|x -subscribe_topic_exception_syntax|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. -The import identifier for this resource is `{msgVpnName}/{aclProfileName}/{subscribeTopicExceptionSyntax}/{subscribeTopicException}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{acl_profile_name}/{subscribe_topic_exception_syntax}/{subscribe_topic_exception}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_authentication_kerberos_realm.md b/docs/resources/msg_vpn_authentication_kerberos_realm.md new file mode 100644 index 00000000..cb3b5e2b --- /dev/null +++ b/docs/resources/msg_vpn_authentication_kerberos_realm.md @@ -0,0 +1,37 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "solacebroker_msg_vpn_authentication_kerberos_realm Resource - solacebroker" +subcategory: "" +description: |- + Kerberos Realm. + 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.40. + The import identifier for this resource is {msg_vpn_name}/{kerberos_realm_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +--- + +# solacebroker_msg_vpn_authentication_kerberos_realm (Resource) + +Kerberos Realm. + + + +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.40. + +The import identifier for this resource is `{msg_vpn_name}/{kerberos_realm_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + + + + +## Schema + +### Required + +- `kerberos_realm_name` (String) The Realm Name. Must start with "@", typically all uppercase. +- `msg_vpn_name` (String) The name of the Message VPN. + +### Optional + +- `enabled` (Boolean) Enable or disable the Realm. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. +- `kdc_address` (String) Address (FQDN or IP) and optional port of the Key Distribution Center for principals in this 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 `""`. diff --git a/docs/resources/msg_vpn_authentication_oauth_profile.md b/docs/resources/msg_vpn_authentication_oauth_profile.md index 4471b8f1..91dc6ce6 100644 --- a/docs/resources/msg_vpn_authentication_oauth_profile.md +++ b/docs/resources/msg_vpn_authentication_oauth_profile.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile Resource - solace subcategory: "" description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - client_secret||x|x - msg_vpn_name|x|| - oauth_profile_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. - The import identifier for this resource is {msgVpnName}/{oauthProfileName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{oauth_profile_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_authentication_oauth_profile (Resource) @@ -19,19 +14,12 @@ description: |- OAuth profiles specify how to securely authenticate to an OAuth provider. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -client_secret||x|x -msg_vpn_name|x|| -oauth_profile_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. -The import identifier for this resource is `{msgVpnName}/{oauthProfileName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{oauth_profile_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -75,6 +63,7 @@ The import identifier for this resource is `{msgVpnName}/{oauthProfileName}`, wh "client" - The broker is in the OAuth client role. "resource-server" - The broker is in the OAuth resource server role. +- `proxy_name` (String) The name of the proxy to use for discovery, user info, jwks, and introspection requests. 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.41. - `resource_server_parse_access_token_enabled` (Boolean) Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. - `resource_server_required_audience` (String) The required audience value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `resource_server_required_issuer` (String) The required issuer value. 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_authentication_oauth_profile_client_required_claim.md b/docs/resources/msg_vpn_authentication_oauth_profile_client_required_claim.md index 94cf8dc3..1b6ec6a2 100644 --- a/docs/resources/msg_vpn_authentication_oauth_profile_client_required_claim.md +++ b/docs/resources/msg_vpn_authentication_oauth_profile_client_required_claim.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_client_required_c subcategory: "" description: |- Additional claims to be verified in the ID token. - Attribute|Identifying - :---|:---: - client_required_claim_name|x - msg_vpn_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. - The import identifier for this resource is {msgVpnName}/{oauthProfileName}/{clientRequiredClaimName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{oauth_profile_name}/{client_required_claim_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_authentication_oauth_profile_client_required_claim (Resource) @@ -19,19 +14,12 @@ description: |- Additional claims to be verified in the ID token. -Attribute|Identifying -:---|:---: -client_required_claim_name|x -msg_vpn_name|x -oauth_profile_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. -The import identifier for this resource is `{msgVpnName}/{oauthProfileName}/{clientRequiredClaimName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{oauth_profile_name}/{client_required_claim_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -41,6 +29,6 @@ The import identifier for this resource is `{msgVpnName}/{oauthProfileName}/{cli ### Required - `client_required_claim_name` (String) The name of the ID token claim to verify. -- `client_required_claim_value` (String) The required claim value. +- `client_required_claim_value` (String) The required claim value. Note that this attribute requires replacement of the resource when updated. - `msg_vpn_name` (String) The name of the Message VPN. - `oauth_profile_name` (String) The name of the OAuth profile. diff --git a/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md b/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md index f1a458c9..037c318c 100644 --- a/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md +++ b/docs/resources/msg_vpn_authentication_oauth_profile_resource_server_required_claim.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_authentication_oauth_profile_resource_server_r subcategory: "" description: |- Additional claims to be verified in the access token. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - oauth_profile_name|x - resource_server_required_claim_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. - The import identifier for this resource is {msgVpnName}/{oauthProfileName}/{resourceServerRequiredClaimName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{oauth_profile_name}/{resource_server_required_claim_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_authentication_oauth_profile_resource_server_required_claim (Resource) @@ -19,19 +14,12 @@ description: |- Additional claims to be verified in the access token. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -oauth_profile_name|x -resource_server_required_claim_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.25. -The import identifier for this resource is `{msgVpnName}/{oauthProfileName}/{resourceServerRequiredClaimName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{oauth_profile_name}/{resource_server_required_claim_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -43,4 +31,4 @@ The import identifier for this resource is `{msgVpnName}/{oauthProfileName}/{res - `msg_vpn_name` (String) The name of the Message VPN. - `oauth_profile_name` (String) The name of the OAuth profile. - `resource_server_required_claim_name` (String) The name of the access token claim to verify. -- `resource_server_required_claim_value` (String) The required claim value. +- `resource_server_required_claim_value` (String) The required claim value. Note that this attribute requires replacement of the resource when updated. diff --git a/docs/resources/msg_vpn_authorization_group.md b/docs/resources/msg_vpn_authorization_group.md index 3376e318..39bcef6a 100644 --- a/docs/resources/msg_vpn_authorization_group.md +++ b/docs/resources/msg_vpn_authorization_group.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_authorization_group Resource - solacebroker" subcategory: "" description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. - Attribute|Identifying|Write-Only - :---|:---:|:---: - authorization_group_name|x| - msg_vpn_name|x| - order_after_authorization_group_name||x - order_before_authorization_group_name||x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{authorizationGroupName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{authorization_group_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_authorization_group (Resource) @@ -20,20 +14,12 @@ description: |- To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority. -Attribute|Identifying|Write-Only -:---|:---:|:---: -authorization_group_name|x| -msg_vpn_name|x| -order_after_authorization_group_name||x -order_before_authorization_group_name||x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{authorizationGroupName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{authorization_group_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_bridge.md b/docs/resources/msg_vpn_bridge.md index 1edd069a..48c4b635 100644 --- a/docs/resources/msg_vpn_bridge.md +++ b/docs/resources/msg_vpn_bridge.md @@ -4,17 +4,9 @@ page_title: "solacebroker_msg_vpn_bridge Resource - solacebroker" subcategory: "" description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - bridge_name|x|| - bridge_virtual_router|x|| - msg_vpn_name|x|| - remote_authentication_basic_password||x|x - remote_authentication_client_cert_content||x|x - remote_authentication_client_cert_password||x| 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. - The import identifier for this resource is {msgVpnName}/{bridgeName}/{bridgeVirtualRouter}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{bridge_name}/{bridge_virtual_router}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_bridge (Resource) @@ -22,22 +14,12 @@ description: |- Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -bridge_name|x|| -bridge_virtual_router|x|| -msg_vpn_name|x|| -remote_authentication_basic_password||x|x -remote_authentication_client_cert_content||x|x -remote_authentication_client_cert_password||x| - - 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. -The import identifier for this resource is `{msgVpnName}/{bridgeName}/{bridgeVirtualRouter}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{bridge_name}/{bridge_virtual_router}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -70,7 +52,7 @@ The import identifier for this resource is `{msgVpnName}/{bridgeName}/{bridgeVir "basic" - Basic Authentication Scheme (via username and password). "client-certificate" - Client Certificate Authentication Scheme (via certificate file or content). -- `remote_connection_retry_count` (Number) The maximum number of retry attempts to establish a connection to the remote Message VPN. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. +- `remote_connection_retry_count` (Number) The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. - `remote_connection_retry_delay` (Number) The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`. - `remote_deliver_to_one_priority` (String) The priority for deliver-to-one (DTO) messages transmitted from 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 `"p1"`. The allowed values and their meaning are: diff --git a/docs/resources/msg_vpn_bridge_remote_msg_vpn.md b/docs/resources/msg_vpn_bridge_remote_msg_vpn.md index 08ff5c63..6ecc7b1b 100644 --- a/docs/resources/msg_vpn_bridge_remote_msg_vpn.md +++ b/docs/resources/msg_vpn_bridge_remote_msg_vpn.md @@ -4,18 +4,9 @@ page_title: "solacebroker_msg_vpn_bridge_remote_msg_vpn Resource - solacebroker" subcategory: "" description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - bridge_name|x|| - bridge_virtual_router|x|| - msg_vpn_name|x|| - password||x|x - remote_msg_vpn_interface|x|| - remote_msg_vpn_location|x|| - remote_msg_vpn_name|x|| 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. - The import identifier for this resource is {msgVpnName}/{bridgeName}/{bridgeVirtualRouter}/{remoteMsgVpnName}/{remoteMsgVpnLocation}/{remoteMsgVpnInterface}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{bridge_name}/{bridge_virtual_router}/{remote_msg_vpn_name}/{remote_msg_vpn_location}/{remote_msg_vpn_interface}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_bridge_remote_msg_vpn (Resource) @@ -23,23 +14,12 @@ description: |- The Remote Message VPN is the Message VPN that the Bridge connects to. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -bridge_name|x|| -bridge_virtual_router|x|| -msg_vpn_name|x|| -password||x|x -remote_msg_vpn_interface|x|| -remote_msg_vpn_location|x|| -remote_msg_vpn_name|x|| - - 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. -The import identifier for this resource is `{msgVpnName}/{bridgeName}/{bridgeVirtualRouter}/{remoteMsgVpnName}/{remoteMsgVpnLocation}/{remoteMsgVpnInterface}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{bridge_name}/{bridge_virtual_router}/{remote_msg_vpn_name}/{remote_msg_vpn_location}/{remote_msg_vpn_interface}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_bridge_remote_subscription.md b/docs/resources/msg_vpn_bridge_remote_subscription.md index b940536a..64af92dd 100644 --- a/docs/resources/msg_vpn_bridge_remote_subscription.md +++ b/docs/resources/msg_vpn_bridge_remote_subscription.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_bridge_remote_subscription Resource - solacebr subcategory: "" description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. - Attribute|Identifying - :---|:---: - bridge_name|x - bridge_virtual_router|x - msg_vpn_name|x - remote_subscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{bridgeName}/{bridgeVirtualRouter}/{remoteSubscriptionTopic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{bridge_name}/{bridge_virtual_router}/{remote_subscription_topic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_bridge_remote_subscription (Resource) @@ -20,20 +14,12 @@ description: |- A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker. -Attribute|Identifying -:---|:---: -bridge_name|x -bridge_virtual_router|x -msg_vpn_name|x -remote_subscription_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{bridgeName}/{bridgeVirtualRouter}/{remoteSubscriptionTopic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{bridge_name}/{bridge_virtual_router}/{remote_subscription_topic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -50,6 +36,6 @@ The import identifier for this resource is `{msgVpnName}/{bridgeName}/{bridgeVir "backup" - The Bridge is used for the backup virtual router. "auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role. -- `deliver_always_enabled` (Boolean) Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both. +- `deliver_always_enabled` (Boolean) Enable or disable deliver-always for the Bridge remote subscription topic instead of a deliver-to-one remote priority. A given topic for the Bridge may be deliver-to-one or deliver-always but not both. Note that this attribute requires replacement of the resource when updated. - `msg_vpn_name` (String) The name of the Message VPN. - `remote_subscription_topic` (String) The topic of the Bridge remote subscription. diff --git a/docs/resources/msg_vpn_cert_matching_rule.md b/docs/resources/msg_vpn_cert_matching_rule.md index b7f2da6a..e802ed9a 100644 --- a/docs/resources/msg_vpn_cert_matching_rule.md +++ b/docs/resources/msg_vpn_cert_matching_rule.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule Resource - solacebroker" subcategory: "" description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - rule_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. - The import identifier for this resource is {msgVpnName}/{ruleName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rule_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_cert_matching_rule (Resource) @@ -18,18 +14,12 @@ description: |- A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -rule_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. -The import identifier for this resource is `{msgVpnName}/{ruleName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rule_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md b/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md index a8d880c4..13d7896e 100644 --- a/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md +++ b/docs/resources/msg_vpn_cert_matching_rule_attribute_filter.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_attribute_filter Resource - subcategory: "" description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. - Attribute|Identifying - :---|:---: - filter_name|x - msg_vpn_name|x - rule_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. - The import identifier for this resource is {msgVpnName}/{ruleName}/{filterName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rule_name}/{filter_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_cert_matching_rule_attribute_filter (Resource) @@ -19,19 +14,12 @@ description: |- A Cert Matching Rule Attribute Filter compares a username attribute to a string. -Attribute|Identifying -:---|:---: -filter_name|x -msg_vpn_name|x -rule_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.28. -The import identifier for this resource is `{msgVpnName}/{ruleName}/{filterName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rule_name}/{filter_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_cert_matching_rule_condition.md b/docs/resources/msg_vpn_cert_matching_rule_condition.md index 0dfe541f..ac499d62 100644 --- a/docs/resources/msg_vpn_cert_matching_rule_condition.md +++ b/docs/resources/msg_vpn_cert_matching_rule_condition.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_cert_matching_rule_condition Resource - solace subcategory: "" description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - rule_name|x - source|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. - The import identifier for this resource is {msgVpnName}/{ruleName}/{source}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rule_name}/{source}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_cert_matching_rule_condition (Resource) @@ -19,19 +14,12 @@ description: |- A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -rule_name|x -source|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. -The import identifier for this resource is `{msgVpnName}/{ruleName}/{source}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rule_name}/{source}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -62,5 +50,5 @@ The import identifier for this resource is `{msgVpnName}/{ruleName}/{source}`, w ### Optional -- `attribute` (String) Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`. -- `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`. +- `attribute` (String) Client Username Attribute to be compared with certificate content. Either an attribute or an expression must be provided on creation, but not both. The default value is `""`. Note that this attribute requires replacement of the resource when updated. +- `expression` (String) Glob expression to be matched with certificate content. Either an expression or an attribute must be provided on creation, but not both. The default value is `""`. Note that this attribute requires replacement of the resource when updated. diff --git a/docs/resources/msg_vpn_client_profile.md b/docs/resources/msg_vpn_client_profile.md index 0eb57255..e3e65cdc 100644 --- a/docs/resources/msg_vpn_client_profile.md +++ b/docs/resources/msg_vpn_client_profile.md @@ -4,16 +4,9 @@ page_title: "solacebroker_msg_vpn_client_profile Resource - solacebroker" subcategory: "" description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. - Attribute|Identifying|Deprecated - :---|:---:|:---: - allow_cut_through_forwarding_enabled||x - api_queue_management_copy_from_on_create_name||x - api_topic_endpoint_management_copy_from_on_create_name||x - client_profile_name|x| - msg_vpn_name|x| 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. - The import identifier for this resource is {msgVpnName}/{clientProfileName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{client_profile_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_client_profile (Resource) @@ -21,21 +14,12 @@ description: |- Client Profiles are used to assign common configuration properties to clients that have been successfully authorized. -Attribute|Identifying|Deprecated -:---|:---:|:---: -allow_cut_through_forwarding_enabled||x -api_queue_management_copy_from_on_create_name||x -api_topic_endpoint_management_copy_from_on_create_name||x -client_profile_name|x| -msg_vpn_name|x| - - 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. -The import identifier for this resource is `{msgVpnName}/{clientProfileName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{client_profile_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_client_username.md b/docs/resources/msg_vpn_client_username.md index affec702..1ba07f7b 100644 --- a/docs/resources/msg_vpn_client_username.md +++ b/docs/resources/msg_vpn_client_username.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_client_username Resource - solacebroker" subcategory: "" description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - client_username|x|| - msg_vpn_name|x|| - password||x|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{clientUsername}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{client_username}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_client_username (Resource) @@ -19,19 +14,12 @@ description: |- A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -client_username|x|| -msg_vpn_name|x|| -password||x|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{clientUsername}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{client_username}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_client_username_attribute.md b/docs/resources/msg_vpn_client_username_attribute.md index 3d544112..d181b5ea 100644 --- a/docs/resources/msg_vpn_client_username_attribute.md +++ b/docs/resources/msg_vpn_client_username_attribute.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_client_username_attribute Resource - solacebro subcategory: "" description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. - Attribute|Identifying - :---|:---: - attribute_name|x - attribute_value|x - client_username|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. - The import identifier for this resource is {msgVpnName}/{clientUsername}/{attributeName}/{attributeValue}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{client_username}/{attribute_name}/{attribute_value}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_client_username_attribute (Resource) @@ -20,20 +14,12 @@ description: |- A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping. -Attribute|Identifying -:---|:---: -attribute_name|x -attribute_value|x -client_username|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. -The import identifier for this resource is `{msgVpnName}/{clientUsername}/{attributeName}/{attributeValue}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{client_username}/{attribute_name}/{attribute_value}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_distributed_cache.md b/docs/resources/msg_vpn_distributed_cache.md index 4df60df8..60af8987 100644 --- a/docs/resources/msg_vpn_distributed_cache.md +++ b/docs/resources/msg_vpn_distributed_cache.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_distributed_cache Resource - solacebroker" subcategory: "" description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. - Attribute|Identifying - :---|:---: - cache_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{cacheName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{cache_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_distributed_cache (Resource) @@ -18,18 +14,12 @@ description: |- A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput. -Attribute|Identifying -:---|:---: -cache_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{cacheName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{cache_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -48,7 +38,7 @@ The import identifier for this resource is `{msgVpnName}/{cacheName}`, where {&l 
 "auto" - The Distributed Cache is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
- Available since SEMP API version 2.28. + Available since SEMP API version 2.28. Note that this attribute requires replacement of the resource when updated. - `enabled` (Boolean) Enable or disable the Distributed Cache. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `heartbeat` (Number) The heartbeat interval, in seconds, used by the Cache Instances to monitor connectivity with the message broker. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `10`. - `scheduled_delete_msg_day_list` (String) The scheduled delete message day(s), specified as "daily" or a comma-separated list of days. Days must be specified as "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", or "Sat", with no spaces, and in sorted order from Sunday to Saturday. The empty-string ("") can also be specified, indicating no schedule is configured ("scheduled_delete_msg_time_list" must also be configured to the empty-string). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster.md b/docs/resources/msg_vpn_distributed_cache_cluster.md index 5978c23c..8f23e0ab 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster Resource - solacebro subcategory: "" description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{cacheName}/{clusterName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{cache_name}/{cluster_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_distributed_cache_cluster (Resource) @@ -19,19 +14,12 @@ description: |- A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{cacheName}/{clusterName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{cache_name}/{cluster_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md index 14772b02..96b73436 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - home_cluster_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{cacheName}/{clusterName}/{homeClusterName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{cache_name}/{cluster_name}/{home_cluster_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_cluster (Resource) @@ -20,20 +14,12 @@ description: |- A Home Cache Cluster is a Cache Cluster that is the "definitive" Cache Cluster for a given topic in the context of the Global Caching feature. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -home_cluster_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{cacheName}/{clusterName}/{homeClusterName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{cache_name}/{cluster_name}/{home_cluster_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md index 8424c06a..e875bf05 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix.md @@ -4,16 +4,9 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_ subcategory: "" description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - home_cluster_name|x - msg_vpn_name|x - topic_prefix|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{cacheName}/{clusterName}/{homeClusterName}/{topicPrefix}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{cache_name}/{cluster_name}/{home_cluster_name}/{topic_prefix}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix (Resource) @@ -21,21 +14,12 @@ description: |- A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -home_cluster_name|x -msg_vpn_name|x -topic_prefix|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{cacheName}/{clusterName}/{homeClusterName}/{topicPrefix}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{cache_name}/{cluster_name}/{home_cluster_name}/{topic_prefix}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -48,4 +32,4 @@ The import identifier for this resource is `{msgVpnName}/{cacheName}/{clusterNam - `cluster_name` (String) The name of the Cache Cluster. - `home_cluster_name` (String) The name of the remote Home Cache Cluster. - `msg_vpn_name` (String) The name of the Message VPN. -- `topic_prefix` (String) A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. +- `topic_prefix` (String) A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_instance.md b/docs/resources/msg_vpn_distributed_cache_cluster_instance.md index 4a485ba8..b7d59680 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_instance.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_instance.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_instance Resource - subcategory: "" description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - instance_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{cacheName}/{clusterName}/{instanceName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{cache_name}/{cluster_name}/{instance_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_distributed_cache_cluster_instance (Resource) @@ -20,20 +14,12 @@ description: |- A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -instance_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{cacheName}/{clusterName}/{instanceName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{cache_name}/{cluster_name}/{instance_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_distributed_cache_cluster_topic.md b/docs/resources/msg_vpn_distributed_cache_cluster_topic.md index 517edec3..df4e4e3c 100644 --- a/docs/resources/msg_vpn_distributed_cache_cluster_topic.md +++ b/docs/resources/msg_vpn_distributed_cache_cluster_topic.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_distributed_cache_cluster_topic Resource - sol subcategory: "" description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. - Attribute|Identifying - :---|:---: - cache_name|x - cluster_name|x - msg_vpn_name|x - topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{cacheName}/{clusterName}/{topic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{cache_name}/{cluster_name}/{topic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_distributed_cache_cluster_topic (Resource) @@ -20,20 +14,12 @@ description: |- The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription. -Attribute|Identifying -:---|:---: -cache_name|x -cluster_name|x -msg_vpn_name|x -topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{cacheName}/{clusterName}/{topic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{cache_name}/{cluster_name}/{topic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_dmr_bridge.md b/docs/resources/msg_vpn_dmr_bridge.md index da23c0a2..3547b6f8 100644 --- a/docs/resources/msg_vpn_dmr_bridge.md +++ b/docs/resources/msg_vpn_dmr_bridge.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_dmr_bridge Resource - solacebroker" subcategory: "" description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - remote_node_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{remoteNodeName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{remote_node_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_dmr_bridge (Resource) @@ -18,18 +14,12 @@ description: |- A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -remote_node_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{remoteNodeName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{remote_node_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_jndi_connection_factory.md b/docs/resources/msg_vpn_jndi_connection_factory.md index 674de657..771c70b3 100644 --- a/docs/resources/msg_vpn_jndi_connection_factory.md +++ b/docs/resources/msg_vpn_jndi_connection_factory.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_jndi_connection_factory Resource - solacebroke subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. - Attribute|Identifying - :---|:---: - connection_factory_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. - The import identifier for this resource is {msgVpnName}/{connectionFactoryName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{connection_factory_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_jndi_connection_factory (Resource) @@ -18,18 +14,12 @@ description: |- The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups. -Attribute|Identifying -:---|:---: -connection_factory_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. -The import identifier for this resource is `{msgVpnName}/{connectionFactoryName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{connection_factory_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_jndi_queue.md b/docs/resources/msg_vpn_jndi_queue.md index 492d9606..e8ffce3e 100644 --- a/docs/resources/msg_vpn_jndi_queue.md +++ b/docs/resources/msg_vpn_jndi_queue.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_jndi_queue Resource - solacebroker" subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. - The import identifier for this resource is {msgVpnName}/{queueName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{queue_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_jndi_queue (Resource) @@ -18,18 +14,12 @@ description: |- The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. -The import identifier for this resource is `{msgVpnName}/{queueName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{queue_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_jndi_topic.md b/docs/resources/msg_vpn_jndi_topic.md index 75394363..d56ba1a1 100644 --- a/docs/resources/msg_vpn_jndi_topic.md +++ b/docs/resources/msg_vpn_jndi_topic.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_jndi_topic Resource - solacebroker" subcategory: "" description: |- The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - topic_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. - The import identifier for this resource is {msgVpnName}/{topicName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{topic_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_jndi_topic (Resource) @@ -18,18 +14,12 @@ description: |- The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -topic_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.2. -The import identifier for this resource is `{msgVpnName}/{topicName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{topic_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_kafka_receiver.md b/docs/resources/msg_vpn_kafka_receiver.md index 0175647c..423f3375 100644 --- a/docs/resources/msg_vpn_kafka_receiver.md +++ b/docs/resources/msg_vpn_kafka_receiver.md @@ -4,18 +4,9 @@ page_title: "solacebroker_msg_vpn_kafka_receiver Resource - solacebroker" subcategory: "" description: |- A Kafka Receiver receives messages from a Kafka Cluster. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_basic_password||x|x - authentication_client_cert_content||x|x - authentication_client_cert_password||x| - authentication_oauth_client_secret||x|x - authentication_scram_password||x|x - kafka_receiver_name|x|| - msg_vpn_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. - The import identifier for this resource is {msgVpnName}/{kafkaReceiverName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{kafka_receiver_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_kafka_receiver (Resource) @@ -23,23 +14,12 @@ description: |- A Kafka Receiver receives messages from a Kafka Cluster. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_basic_password||x|x -authentication_client_cert_content||x|x -authentication_client_cert_password||x| -authentication_oauth_client_secret||x|x -authentication_scram_password||x|x -kafka_receiver_name|x|| -msg_vpn_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. -The import identifier for this resource is `{msgVpnName}/{kafkaReceiverName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{kafka_receiver_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -57,6 +37,10 @@ The import identifier for this resource is `{msgVpnName}/{kafkaReceiverName}`, w - `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_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 `""`. @@ -68,6 +52,7 @@ The import identifier for this resource is `{msgVpnName}/{kafkaReceiverName}`, w "basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports. +"kerberos" - Kerberos Authentication. "oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports. - `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: @@ -124,6 +109,6 @@ Modifying this attribute while the object (or the relevant part of the object) i This corresponds to the Kafka consumer API `partition.assignment.strategy` configuration setting. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"range,roundrobin"`. -- `metadata_topic_exclude_list` (String) A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `metadata_topic_exclude_list` (String) A comma-separated list of POSIX.2 regular expressions. Commas within each regular expression must be escaped as double commas. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `metadata_topic_refresh_interval` (Number) The time between refreshes of topic metadata from the Kafka Cluster. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `30000`. - `transport_tls_enabled` (Boolean) Enable or disable encryption (TLS) for the Kafka Receiver. The bootstrap addresses must resolve to PLAINTEXT or SASL_PLAINTEXT listener ports when disabled, and SSL or SASL_SSL listener ports when enabled. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. diff --git a/docs/resources/msg_vpn_kafka_receiver_topic_binding.md b/docs/resources/msg_vpn_kafka_receiver_topic_binding.md index 76895153..194fa944 100644 --- a/docs/resources/msg_vpn_kafka_receiver_topic_binding.md +++ b/docs/resources/msg_vpn_kafka_receiver_topic_binding.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_kafka_receiver_topic_binding Resource - solace subcategory: "" description: |- A Topic Binding receives messages from a remote Kafka Topic. - Attribute|Identifying - :---|:---: - kafka_receiver_name|x - msg_vpn_name|x - topic_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. - The import identifier for this resource is {msgVpnName}/{kafkaReceiverName}/{topicName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{kafka_receiver_name}/{topic_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_kafka_receiver_topic_binding (Resource) @@ -19,19 +14,12 @@ description: |- A Topic Binding receives messages from a remote Kafka Topic. -Attribute|Identifying -:---|:---: -kafka_receiver_name|x -msg_vpn_name|x -topic_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. -The import identifier for this resource is `{msgVpnName}/{kafkaReceiverName}/{topicName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{kafka_receiver_name}/{topic_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -42,7 +30,7 @@ The import identifier for this resource is `{msgVpnName}/{kafkaReceiverName}/{to - `kafka_receiver_name` (String) The name of the Kafka Receiver. - `msg_vpn_name` (String) The name of the Message VPN. -- `topic_name` (String) The name of the Topic. +- `topic_name` (String) The name of the Topic or a POSIX.2 regular expression starting with '^'. ### Optional diff --git a/docs/resources/msg_vpn_kafka_sender.md b/docs/resources/msg_vpn_kafka_sender.md index e144126a..88899a18 100644 --- a/docs/resources/msg_vpn_kafka_sender.md +++ b/docs/resources/msg_vpn_kafka_sender.md @@ -4,18 +4,9 @@ page_title: "solacebroker_msg_vpn_kafka_sender Resource - solacebroker" subcategory: "" description: |- A Kafka Sender sends messages to a Kafka Cluster. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_basic_password||x|x - authentication_client_cert_content||x|x - authentication_client_cert_password||x| - authentication_oauth_client_secret||x|x - authentication_scram_password||x|x - kafka_sender_name|x|| - msg_vpn_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. - The import identifier for this resource is {msgVpnName}/{kafkaSenderName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{kafka_sender_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_kafka_sender (Resource) @@ -23,23 +14,12 @@ description: |- A Kafka Sender sends messages to a Kafka Cluster. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_basic_password||x|x -authentication_client_cert_content||x|x -authentication_client_cert_password||x| -authentication_oauth_client_secret||x|x -authentication_scram_password||x|x -kafka_sender_name|x|| -msg_vpn_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. -The import identifier for this resource is `{msgVpnName}/{kafkaSenderName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{kafka_sender_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -57,6 +37,10 @@ The import identifier for this resource is `{msgVpnName}/{kafkaSenderName}`, whe - `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_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 `""`. @@ -68,6 +52,7 @@ The import identifier for this resource is `{msgVpnName}/{kafkaSenderName}`, whe "basic" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "scram" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports. "client-certificate" - Client Certificate Authentication. Used with Kafka broker SSL listener ports. +"kerberos" - Kerberos Authentication. "oauth-client" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports. - `authentication_scram_hash` (String) The hash used for SCRAM authentication. To be used when authentication_scheme is "scram". Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `"sha-512"`. The allowed values and their meaning are: diff --git a/docs/resources/msg_vpn_kafka_sender_queue_binding.md b/docs/resources/msg_vpn_kafka_sender_queue_binding.md index 3d21fa6f..3a1eb059 100644 --- a/docs/resources/msg_vpn_kafka_sender_queue_binding.md +++ b/docs/resources/msg_vpn_kafka_sender_queue_binding.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_kafka_sender_queue_binding Resource - solacebr subcategory: "" description: |- A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic. - Attribute|Identifying - :---|:---: - kafka_sender_name|x - msg_vpn_name|x - queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. - The import identifier for this resource is {msgVpnName}/{kafkaSenderName}/{queueName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{kafka_sender_name}/{queue_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_kafka_sender_queue_binding (Resource) @@ -19,19 +14,12 @@ description: |- A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic. -Attribute|Identifying -:---|:---: -kafka_sender_name|x -msg_vpn_name|x -queue_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. -The import identifier for this resource is `{msgVpnName}/{kafkaSenderName}/{queueName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{kafka_sender_name}/{queue_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_mqtt_retain_cache.md b/docs/resources/msg_vpn_mqtt_retain_cache.md index a8ffe8cd..f4760ad0 100644 --- a/docs/resources/msg_vpn_mqtt_retain_cache.md +++ b/docs/resources/msg_vpn_mqtt_retain_cache.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_mqtt_retain_cache Resource - solacebroker" subcategory: "" description: |- Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. - Attribute|Identifying - :---|:---: - cache_name|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. - The import identifier for this resource is {msgVpnName}/{cacheName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{cache_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_mqtt_retain_cache (Resource) @@ -18,18 +14,12 @@ description: |- Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN. -Attribute|Identifying -:---|:---: -cache_name|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.11. -The import identifier for this resource is `{msgVpnName}/{cacheName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{cache_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_mqtt_session.md b/docs/resources/msg_vpn_mqtt_session.md index 7ac09c5c..ea5964a9 100644 --- a/docs/resources/msg_vpn_mqtt_session.md +++ b/docs/resources/msg_vpn_mqtt_session.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_mqtt_session Resource - solacebroker" subcategory: "" description: |- An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). - Attribute|Identifying - :---|:---: - mqtt_session_client_id|x - mqtt_session_virtual_router|x - msg_vpn_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. - The import identifier for this resource is {msgVpnName}/{mqttSessionClientId}/{mqttSessionVirtualRouter}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{mqtt_session_client_id}/{mqtt_session_virtual_router}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_mqtt_session (Resource) @@ -19,19 +14,12 @@ description: |- An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages). -Attribute|Identifying -:---|:---: -mqtt_session_client_id|x -mqtt_session_virtual_router|x -msg_vpn_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. -The import identifier for this resource is `{msgVpnName}/{mqttSessionClientId}/{mqttSessionVirtualRouter}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{mqtt_session_client_id}/{mqtt_session_virtual_router}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_mqtt_session_subscription.md b/docs/resources/msg_vpn_mqtt_session_subscription.md index cdfb86fe..e680556d 100644 --- a/docs/resources/msg_vpn_mqtt_session_subscription.md +++ b/docs/resources/msg_vpn_mqtt_session_subscription.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_mqtt_session_subscription Resource - solacebro subcategory: "" description: |- An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. - Attribute|Identifying - :---|:---: - mqtt_session_client_id|x - mqtt_session_virtual_router|x - msg_vpn_name|x - subscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. - The import identifier for this resource is {msgVpnName}/{mqttSessionClientId}/{mqttSessionVirtualRouter}/{subscriptionTopic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{mqtt_session_client_id}/{mqtt_session_virtual_router}/{subscription_topic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_mqtt_session_subscription (Resource) @@ -20,20 +14,12 @@ description: |- An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0. -Attribute|Identifying -:---|:---: -mqtt_session_client_id|x -mqtt_session_virtual_router|x -msg_vpn_name|x -subscription_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. -The import identifier for this resource is `{msgVpnName}/{mqttSessionClientId}/{mqttSessionVirtualRouter}/{subscriptionTopic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{mqtt_session_client_id}/{mqtt_session_virtual_router}/{subscription_topic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_proxy.md b/docs/resources/msg_vpn_proxy.md index 0a0d1030..776bc8e5 100644 --- a/docs/resources/msg_vpn_proxy.md +++ b/docs/resources/msg_vpn_proxy.md @@ -3,27 +3,15 @@ page_title: "solacebroker_msg_vpn_proxy Resource - solacebroker" subcategory: "" description: |- - Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_basic_password||x|x - msg_vpn_name|x|| - proxy_name|x|| + proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.36. - The import identifier for this resource is {msgVpnName}/{proxyName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{proxy_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_proxy (Resource) -Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. - - -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_basic_password||x|x -msg_vpn_name|x|| -proxy_name|x|| +proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object. @@ -31,7 +19,7 @@ A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is This has been available since SEMP API version 2.36. -The import identifier for this resource is `{msgVpnName}/{proxyName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{proxy_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -53,7 +41,7 @@ The import identifier for this resource is `{msgVpnName}/{proxyName}`, where {&l "none" - No authentication. "basic" - Username/password authentication. -- `enabled` (Boolean) Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. +- `enabled` (Boolean) Enable or disable the proxy. When disabled, no connections are initiated to this particular proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. - `host` (String) The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `port` (Number) The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. - `proxy_type` (String) The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"direct"`. The allowed values and their meaning are: diff --git a/docs/resources/msg_vpn_queue.md b/docs/resources/msg_vpn_queue.md index f8b34980..355a3c26 100644 --- a/docs/resources/msg_vpn_queue.md +++ b/docs/resources/msg_vpn_queue.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_queue Resource - solacebroker" subcategory: "" description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{queueName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{queue_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_queue (Resource) @@ -18,18 +14,12 @@ description: |- A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{queueName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{queue_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_queue_subscription.md b/docs/resources/msg_vpn_queue_subscription.md index beb28c65..6e25fd25 100644 --- a/docs/resources/msg_vpn_queue_subscription.md +++ b/docs/resources/msg_vpn_queue_subscription.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_queue_subscription Resource - solacebroker" subcategory: "" description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_name|x - subscription_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{queueName}/{subscriptionTopic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{queue_name}/{subscription_topic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_queue_subscription (Resource) @@ -19,19 +14,12 @@ description: |- One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_name|x -subscription_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{queueName}/{subscriptionTopic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{queue_name}/{subscription_topic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_queue_template.md b/docs/resources/msg_vpn_queue_template.md index 9c3e2591..112a0b52 100644 --- a/docs/resources/msg_vpn_queue_template.md +++ b/docs/resources/msg_vpn_queue_template.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_queue_template Resource - solacebroker" subcategory: "" description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_template_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. - The import identifier for this resource is {msgVpnName}/{queueTemplateName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{queue_template_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_queue_template (Resource) @@ -18,18 +14,12 @@ description: |- A Queue Template provides a mechanism for specifying the initial state for client created queues. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_template_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. -The import identifier for this resource is `{msgVpnName}/{queueTemplateName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{queue_template_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -76,7 +66,7 @@ The import identifier for this resource is `{msgVpnName}/{queueTemplateName}`, w "modify-topic" - Consume messages or modify the topic/selector. "delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether. -- `queue_name_filter` (String) A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `queue_name_filter` (String) A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. - `redelivery_delay_enabled` (Boolean) Enable or disable a message redelivery delay. When false, messages are redelivered as soon as possible. When true, messages are redelivered according to the initial, max and multiplier. This should only be enabled when redelivery is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.33. - `redelivery_delay_initial_interval` (Number) The delay to be used between the first 2 redelivery attempts. This value is in milliseconds. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`. Available since SEMP API version 2.33. - `redelivery_delay_max_interval` (Number) The maximum delay to be used between any 2 redelivery attempts. This value is in milliseconds. Due to technical limitations, some redelivery attempt delays may slightly exceed this value. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `64000`. Available since SEMP API version 2.33. diff --git a/docs/resources/msg_vpn_replay_log.md b/docs/resources/msg_vpn_replay_log.md index 0858591b..c312cd0d 100644 --- a/docs/resources/msg_vpn_replay_log.md +++ b/docs/resources/msg_vpn_replay_log.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_replay_log Resource - solacebroker" subcategory: "" description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - replay_log_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.10. - The import identifier for this resource is {msgVpnName}/{replayLogName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{replay_log_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_replay_log (Resource) @@ -18,18 +14,12 @@ description: |- When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -replay_log_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.10. -The import identifier for this resource is `{msgVpnName}/{replayLogName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{replay_log_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md b/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md index b87a9946..65f3aabf 100644 --- a/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md +++ b/docs/resources/msg_vpn_replay_log_topic_filter_subscription.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_replay_log_topic_filter_subscription Resource subcategory: "" description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - replay_log_name|x - topic_filter_subscription|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. - The import identifier for this resource is {msgVpnName}/{replayLogName}/{topicFilterSubscription}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{replay_log_name}/{topic_filter_subscription}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_replay_log_topic_filter_subscription (Resource) @@ -19,19 +14,12 @@ description: |- One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -replay_log_name|x -topic_filter_subscription|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.27. -The import identifier for this resource is `{msgVpnName}/{replayLogName}/{topicFilterSubscription}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{replay_log_name}/{topic_filter_subscription}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_replicated_topic.md b/docs/resources/msg_vpn_replicated_topic.md index a4508533..767bc3b9 100644 --- a/docs/resources/msg_vpn_replicated_topic.md +++ b/docs/resources/msg_vpn_replicated_topic.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_replicated_topic Resource - solacebroker" subcategory: "" description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - replicated_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. - The import identifier for this resource is {msgVpnName}/{replicatedTopic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{replicated_topic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_replicated_topic (Resource) @@ -18,18 +14,12 @@ description: |- To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -replicated_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. -The import identifier for this resource is `{msgVpnName}/{replicatedTopic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{replicated_topic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_rest_delivery_point.md b/docs/resources/msg_vpn_rest_delivery_point.md index ec50f624..7573dd00 100644 --- a/docs/resources/msg_vpn_rest_delivery_point.md +++ b/docs/resources/msg_vpn_rest_delivery_point.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point Resource - solacebroker" subcategory: "" description: |- A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{restDeliveryPointName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rest_delivery_point_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_rest_delivery_point (Resource) @@ -18,18 +14,12 @@ description: |- A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{restDeliveryPointName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md b/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md index 9db2489c..14ff4dfc 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md +++ b/docs/resources/msg_vpn_rest_delivery_point_queue_binding.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding Resource - s subcategory: "" description: |- A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - queue_binding_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{restDeliveryPointName}/{queueBindingName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rest_delivery_point_name}/{queue_binding_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_rest_delivery_point_queue_binding (Resource) @@ -19,19 +14,12 @@ description: |- A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -queue_binding_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{restDeliveryPointName}/{queueBindingName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_name}/{queue_binding_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. 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 8e756685..b4f3beb4 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md +++ b/docs/resources/msg_vpn_rest_delivery_point_queue_binding_protected_request_header.md @@ -4,16 +4,9 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_protected_re subcategory: "" description: |- A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - header_name|x|| - header_value||x|x - msg_vpn_name|x|| - queue_binding_name|x|| - rest_delivery_point_name|x|| A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.30. - The import identifier for this resource is {msgVpnName}/{restDeliveryPointName}/{queueBindingName}/{headerName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rest_delivery_point_name}/{queue_binding_name}/{header_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_rest_delivery_point_queue_binding_protected_request_header (Resource) @@ -21,21 +14,12 @@ description: |- A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -header_name|x|| -header_value||x|x -msg_vpn_name|x|| -queue_binding_name|x|| -rest_delivery_point_name|x|| - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.30. -The import identifier for this resource is `{msgVpnName}/{restDeliveryPointName}/{queueBindingName}/{headerName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_name}/{queue_binding_name}/{header_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md b/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md index 32f8bc2f..7f68617e 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md +++ b/docs/resources/msg_vpn_rest_delivery_point_queue_binding_request_header.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_head subcategory: "" description: |- A request header to be added to the HTTP request. - Attribute|Identifying - :---|:---: - header_name|x - msg_vpn_name|x - queue_binding_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.23. - The import identifier for this resource is {msgVpnName}/{restDeliveryPointName}/{queueBindingName}/{headerName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rest_delivery_point_name}/{queue_binding_name}/{header_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_rest_delivery_point_queue_binding_request_header (Resource) @@ -20,20 +14,12 @@ description: |- A request header to be added to the HTTP request. -Attribute|Identifying -:---|:---: -header_name|x -msg_vpn_name|x -queue_binding_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.23. -The import identifier for this resource is `{msgVpnName}/{restDeliveryPointName}/{queueBindingName}/{headerName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_name}/{queue_binding_name}/{header_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. 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 319d4091..4d941d7e 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md +++ b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer.md @@ -4,21 +4,9 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer Resource - s subcategory: "" description: |- REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - authentication_aws_secret_access_key||x|x - authentication_client_cert_content||x|x - authentication_client_cert_password||x| - authentication_http_basic_password||x|x - authentication_http_header_value||x|x - authentication_oauth_client_secret||x|x - authentication_oauth_jwt_secret_key||x|x - msg_vpn_name|x|| - rest_consumer_name|x|| - rest_delivery_point_name|x|| 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. - The import identifier for this resource is {msgVpnName}/{restDeliveryPointName}/{restConsumerName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rest_delivery_point_name}/{rest_consumer_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_rest_delivery_point_rest_consumer (Resource) @@ -26,26 +14,12 @@ description: |- REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker. -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -authentication_aws_secret_access_key||x|x -authentication_client_cert_content||x|x -authentication_client_cert_password||x| -authentication_http_basic_password||x|x -authentication_http_header_value||x|x -authentication_oauth_client_secret||x|x -authentication_oauth_jwt_secret_key||x|x -msg_vpn_name|x|| -rest_consumer_name|x|| -rest_delivery_point_name|x|| - - 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. -The import identifier for this resource is `{msgVpnName}/{restDeliveryPointName}/{restConsumerName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_name}/{rest_consumer_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md index 9535f488..4a732f66 100644 --- a/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md +++ b/docs/resources/msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim.md @@ -4,15 +4,9 @@ page_title: "solacebroker_msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_cl subcategory: "" description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - oauth_jwt_claim_name|x - rest_consumer_name|x - rest_delivery_point_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.21. - The import identifier for this resource is {msgVpnName}/{restDeliveryPointName}/{restConsumerName}/{oauthJwtClaimName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{rest_delivery_point_name}/{rest_consumer_name}/{oauth_jwt_claim_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim (Resource) @@ -20,20 +14,12 @@ description: |- A Claim is added to the JWT sent to the OAuth token request endpoint. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -oauth_jwt_claim_name|x -rest_consumer_name|x -rest_delivery_point_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.21. -The import identifier for this resource is `{msgVpnName}/{restDeliveryPointName}/{restConsumerName}/{oauthJwtClaimName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{rest_delivery_point_name}/{rest_consumer_name}/{oauth_jwt_claim_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -44,6 +30,6 @@ The import identifier for this resource is `{msgVpnName}/{restDeliveryPointName} - `msg_vpn_name` (String) The name of the Message VPN. - `oauth_jwt_claim_name` (String) The name of the additional claim. Cannot be "exp", "iat", or "jti". -- `oauth_jwt_claim_value` (String) The value of the additional claim, which must be a string containing a valid JSON value. +- `oauth_jwt_claim_value` (String) The value of the additional claim, which must be a string containing a valid JSON value. Note that this attribute requires replacement of the resource when updated. - `rest_consumer_name` (String) The name of the REST Consumer. - `rest_delivery_point_name` (String) The name of the REST Delivery Point. diff --git a/docs/resources/msg_vpn_sequenced_topic.md b/docs/resources/msg_vpn_sequenced_topic.md index a6d6be2f..bb381a71 100644 --- a/docs/resources/msg_vpn_sequenced_topic.md +++ b/docs/resources/msg_vpn_sequenced_topic.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_sequenced_topic Resource - solacebroker" subcategory: "" description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - sequenced_topic|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. - The import identifier for this resource is {msgVpnName}/{sequencedTopic}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + 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. --- # solacebroker_msg_vpn_sequenced_topic (Resource) @@ -18,18 +14,12 @@ description: |- A Sequenced Topic is a topic subscription for which any matching messages received on the Message VPN are assigned a sequence number that is monotonically increased by a value of one per message. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -sequenced_topic|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.0. -The import identifier for this resource is `{msgVpnName}/{sequencedTopic}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +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. diff --git a/docs/resources/msg_vpn_telemetry_profile.md b/docs/resources/msg_vpn_telemetry_profile.md index 0d2872b3..adb988e5 100644 --- a/docs/resources/msg_vpn_telemetry_profile.md +++ b/docs/resources/msg_vpn_telemetry_profile.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_telemetry_profile Resource - solacebroker" subcategory: "" description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - telemetry_profile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. - The import identifier for this resource is {msgVpnName}/{telemetryProfileName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{telemetry_profile_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_telemetry_profile (Resource) @@ -18,18 +14,12 @@ description: |- Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -telemetry_profile_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. -The import identifier for this resource is `{msgVpnName}/{telemetryProfileName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{telemetry_profile_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md b/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md index 309748f8..d2cc2d9c 100644 --- a/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md +++ b/docs/resources/msg_vpn_telemetry_profile_receiver_acl_connect_exception.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_receiver_acl_connect_excepti subcategory: "" description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - receiver_acl_connect_exception_address|x - telemetry_profile_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. - The import identifier for this resource is {msgVpnName}/{telemetryProfileName}/{receiverAclConnectExceptionAddress}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{telemetry_profile_name}/{receiver_acl_connect_exception_address}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_telemetry_profile_receiver_acl_connect_exception (Resource) @@ -19,19 +14,12 @@ description: |- A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -receiver_acl_connect_exception_address|x -telemetry_profile_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. -The import identifier for this resource is `{msgVpnName}/{telemetryProfileName}/{receiverAclConnectExceptionAddress}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{telemetry_profile_name}/{receiver_acl_connect_exception_address}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_telemetry_profile_trace_filter.md b/docs/resources/msg_vpn_telemetry_profile_trace_filter.md index 25a905e4..c0e09fda 100644 --- a/docs/resources/msg_vpn_telemetry_profile_trace_filter.md +++ b/docs/resources/msg_vpn_telemetry_profile_trace_filter.md @@ -4,14 +4,9 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter Resource - sola subcategory: "" description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - telemetry_profile_name|x - trace_filter_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. - The import identifier for this resource is {msgVpnName}/{telemetryProfileName}/{traceFilterName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{telemetry_profile_name}/{trace_filter_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_telemetry_profile_trace_filter (Resource) @@ -19,19 +14,12 @@ description: |- A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -telemetry_profile_name|x -trace_filter_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. -The import identifier for this resource is `{msgVpnName}/{telemetryProfileName}/{traceFilterName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{telemetry_profile_name}/{trace_filter_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md b/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md index 6ef88db3..431e72d5 100644 --- a/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md +++ b/docs/resources/msg_vpn_telemetry_profile_trace_filter_subscription.md @@ -4,16 +4,9 @@ page_title: "solacebroker_msg_vpn_telemetry_profile_trace_filter_subscription Re subcategory: "" description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - subscription|x - subscription_syntax|x - telemetry_profile_name|x - trace_filter_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. - The import identifier for this resource is {msgVpnName}/{telemetryProfileName}/{traceFilterName}/{subscription}/{subscriptionSyntax}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{telemetry_profile_name}/{trace_filter_name}/{subscription}/{subscription_syntax}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_telemetry_profile_trace_filter_subscription (Resource) @@ -21,21 +14,12 @@ description: |- Trace filter subscriptions control which messages will be attracted by the tracing filter. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -subscription|x -subscription_syntax|x -telemetry_profile_name|x -trace_filter_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.31. -The import identifier for this resource is `{msgVpnName}/{telemetryProfileName}/{traceFilterName}/{subscription}/{subscriptionSyntax}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{telemetry_profile_name}/{trace_filter_name}/{subscription}/{subscription_syntax}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_topic_endpoint.md b/docs/resources/msg_vpn_topic_endpoint.md index 6df53319..407e29d2 100644 --- a/docs/resources/msg_vpn_topic_endpoint.md +++ b/docs/resources/msg_vpn_topic_endpoint.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_topic_endpoint Resource - solacebroker" subcategory: "" description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - topic_endpoint_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. - The import identifier for this resource is {msgVpnName}/{topicEndpointName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{topic_endpoint_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_topic_endpoint (Resource) @@ -18,18 +14,12 @@ description: |- A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -topic_endpoint_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.1. -The import identifier for this resource is `{msgVpnName}/{topicEndpointName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{topic_endpoint_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/msg_vpn_topic_endpoint_template.md b/docs/resources/msg_vpn_topic_endpoint_template.md index c6f3af24..8153d670 100644 --- a/docs/resources/msg_vpn_topic_endpoint_template.md +++ b/docs/resources/msg_vpn_topic_endpoint_template.md @@ -4,13 +4,9 @@ page_title: "solacebroker_msg_vpn_topic_endpoint_template Resource - solacebroke subcategory: "" description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - topic_endpoint_template_name|x A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. - The import identifier for this resource is {msgVpnName}/{topicEndpointTemplateName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {msg_vpn_name}/{topic_endpoint_template_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_msg_vpn_topic_endpoint_template (Resource) @@ -18,18 +14,12 @@ description: |- A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints. -Attribute|Identifying -:---|:---: -msg_vpn_name|x -topic_endpoint_template_name|x - - A SEMP client authorized with a minimum access scope/level of "vpn/read-only" is required to perform this operation. This has been available since SEMP API version 2.14. -The import identifier for this resource is `{msgVpnName}/{topicEndpointTemplateName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{msg_vpn_name}/{topic_endpoint_template_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -86,7 +76,7 @@ The import identifier for this resource is `{msgVpnName}/{topicEndpointTemplateN - `respect_msg_priority_enabled` (Boolean) Enable or disable the respecting of message priority. When enabled, messages are delivered in priority order, from 9 (highest) to 0 (lowest). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. - `respect_ttl_enabled` (Boolean) Enable or disable the respecting of the time-to-live (TTL) for messages. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. -- `topic_endpoint_name_filter` (String) A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. +- `topic_endpoint_name_filter` (String) A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `""`. ### Nested Schema for `event_bind_count_threshold` diff --git a/docs/resources/oauth_profile.md b/docs/resources/oauth_profile.md index f31e197e..490ec639 100644 --- a/docs/resources/oauth_profile.md +++ b/docs/resources/oauth_profile.md @@ -3,25 +3,18 @@ page_title: "solacebroker_oauth_profile Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. OAuth profiles specify how to securely authenticate to an OAuth provider. - Attribute|Identifying|Write-Only|Opaque - :---|:---:|:---:|:---: - client_secret||x|x - oauth_profile_name|x|| A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile (Resource) -OAuth profiles specify how to securely authenticate to an OAuth provider. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying|Write-Only|Opaque -:---|:---:|:---:|:---: -client_secret||x|x -oauth_profile_name|x|| +OAuth profiles specify how to securely authenticate to an OAuth provider. @@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -94,6 +87,7 @@ The import identifier for this resource is `{oauthProfileName}`, where {<attr "client" - The broker is in the OAuth client role. "resource-server" - The broker is in the OAuth resource server role. +- `proxy_name` (String) The name of the proxy to use for discovery, user info, jwks, and introspection requests. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. Available since SEMP API version 2.41. - `resource_server_parse_access_token_enabled` (Boolean) Enable or disable parsing of the access token as a JWT. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. - `resource_server_required_audience` (String) The required audience value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. - `resource_server_required_issuer` (String) The required issuer value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. diff --git a/docs/resources/oauth_profile_access_level_group.md b/docs/resources/oauth_profile_access_level_group.md index 89252296..d9c4a940 100644 --- a/docs/resources/oauth_profile_access_level_group.md +++ b/docs/resources/oauth_profile_access_level_group.md @@ -3,25 +3,18 @@ page_title: "solacebroker_oauth_profile_access_level_group Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - Attribute|Identifying - :---|:---: - group_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}/{groupName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}/{group_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile_access_level_group (Resource) -The name of a group as it exists on the OAuth server being used to authenticate SEMP users. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -group_name|x -oauth_profile_name|x +The name of a group as it exists on the OAuth server being used to authenticate SEMP users. @@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}/{groupName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}/{group_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md b/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md index 824a158b..b574531b 100644 --- a/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md +++ b/docs/resources/oauth_profile_access_level_group_msg_vpn_access_level_exception.md @@ -3,27 +3,18 @@ page_title: "solacebroker_oauth_profile_access_level_group_msg_vpn_access_level_exception Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Message VPN access-level exceptions for members of this group. - Attribute|Identifying - :---|:---: - group_name|x - msg_vpn_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}/{groupName}/{msgVpnName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}/{group_name}/{msg_vpn_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile_access_level_group_msg_vpn_access_level_exception (Resource) -Message VPN access-level exceptions for members of this group. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -group_name|x -msg_vpn_name|x -oauth_profile_name|x +Message VPN access-level exceptions for members of this group. @@ -31,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}/{groupName}/{msgVpnName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}/{group_name}/{msg_vpn_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/oauth_profile_client_allowed_host.md b/docs/resources/oauth_profile_client_allowed_host.md index 0a7365f8..a897b33f 100644 --- a/docs/resources/oauth_profile_client_allowed_host.md +++ b/docs/resources/oauth_profile_client_allowed_host.md @@ -3,25 +3,18 @@ page_title: "solacebroker_oauth_profile_client_allowed_host Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. A valid hostname for this broker in OAuth redirects. - Attribute|Identifying - :---|:---: - allowed_host|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}/{allowedHost}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}/{allowed_host}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile_client_allowed_host (Resource) -A valid hostname for this broker in OAuth redirects. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -allowed_host|x -oauth_profile_name|x +A valid hostname for this broker in OAuth redirects. @@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}/{allowedHost}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}/{allowed_host}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/oauth_profile_client_authorization_parameter.md b/docs/resources/oauth_profile_client_authorization_parameter.md index cffb8576..fc08205d 100644 --- a/docs/resources/oauth_profile_client_authorization_parameter.md +++ b/docs/resources/oauth_profile_client_authorization_parameter.md @@ -3,25 +3,18 @@ page_title: "solacebroker_oauth_profile_client_authorization_parameter Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Additional parameters to be passed to the OAuth authorization endpoint. - Attribute|Identifying - :---|:---: - authorization_parameter_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}/{authorizationParameterName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}/{authorization_parameter_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile_client_authorization_parameter (Resource) -Additional parameters to be passed to the OAuth authorization endpoint. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -authorization_parameter_name|x -oauth_profile_name|x +Additional parameters to be passed to the OAuth authorization endpoint. @@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}/{authorizationParameterName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}/{authorization_parameter_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/oauth_profile_client_required_claim.md b/docs/resources/oauth_profile_client_required_claim.md index f23a67e6..c7e864e1 100644 --- a/docs/resources/oauth_profile_client_required_claim.md +++ b/docs/resources/oauth_profile_client_required_claim.md @@ -3,25 +3,18 @@ page_title: "solacebroker_oauth_profile_client_required_claim Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Additional claims to be verified in the ID token. - Attribute|Identifying - :---|:---: - client_required_claim_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}/{clientRequiredClaimName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}/{client_required_claim_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile_client_required_claim (Resource) -Additional claims to be verified in the ID token. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -client_required_claim_name|x -oauth_profile_name|x +Additional claims to be verified in the ID token. @@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}/{clientRequiredClaimName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}/{client_required_claim_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -39,5 +32,5 @@ The import identifier for this resource is `{oauthProfileName}/{clientRequiredCl ### Required - `client_required_claim_name` (String) The name of the ID token claim to verify. -- `client_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. +- `client_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. Note that this attribute requires replacement of the resource when updated. - `oauth_profile_name` (String) The name of the OAuth profile. diff --git a/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md b/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md index acc29893..79b7b839 100644 --- a/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md +++ b/docs/resources/oauth_profile_default_msg_vpn_access_level_exception.md @@ -3,25 +3,18 @@ page_title: "solacebroker_oauth_profile_default_msg_vpn_access_level_exception Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Default message VPN access-level exceptions. - Attribute|Identifying - :---|:---: - msg_vpn_name|x - oauth_profile_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}/{msgVpnName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}/{msg_vpn_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile_default_msg_vpn_access_level_exception (Resource) -Default message VPN access-level exceptions. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -msg_vpn_name|x -oauth_profile_name|x +Default message VPN access-level exceptions. @@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}/{msgVpnName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}/{msg_vpn_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/docs/resources/oauth_profile_resource_server_required_claim.md b/docs/resources/oauth_profile_resource_server_required_claim.md index 3c44a3ef..411226db 100644 --- a/docs/resources/oauth_profile_resource_server_required_claim.md +++ b/docs/resources/oauth_profile_resource_server_required_claim.md @@ -3,25 +3,18 @@ page_title: "solacebroker_oauth_profile_resource_server_required_claim Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. Additional claims to be verified in the access token. - Attribute|Identifying - :---|:---: - oauth_profile_name|x - resource_server_required_claim_name|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.24. - The import identifier for this resource is {oauthProfileName}/{resourceServerRequiredClaimName}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {oauth_profile_name}/{resource_server_required_claim_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_oauth_profile_resource_server_required_claim (Resource) -Additional claims to be verified in the access token. - +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). -Attribute|Identifying -:---|:---: -oauth_profile_name|x -resource_server_required_claim_name|x +Additional claims to be verified in the access token. @@ -29,7 +22,7 @@ A SEMP client authorized with a minimum access scope/level of "global/read-only" This has been available since SEMP API version 2.24. -The import identifier for this resource is `{oauthProfileName}/{resourceServerRequiredClaimName}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{oauth_profile_name}/{resource_server_required_claim_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. @@ -40,4 +33,4 @@ The import identifier for this resource is `{oauthProfileName}/{resourceServerRe - `oauth_profile_name` (String) The name of the OAuth profile. - `resource_server_required_claim_name` (String) The name of the access token claim to verify. -- `resource_server_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. +- `resource_server_required_claim_value` (String) The required claim value, which must be a string containing a valid JSON value. Note that this attribute requires replacement of the resource when updated. diff --git a/docs/resources/proxy.md b/docs/resources/proxy.md new file mode 100644 index 00000000..18d5f422 --- /dev/null +++ b/docs/resources/proxy.md @@ -0,0 +1,54 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "solacebroker_proxy Resource - solacebroker" +subcategory: "" +description: |- + This resource is not supported in production by Solace in this version, see provider limitations. + proxy 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. + A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. + This has been available since SEMP API version 2.41. + The import identifier for this resource is {proxy_name}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +--- + +# solacebroker_proxy (Resource) + +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). + +proxy 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. + + + +A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. + +This has been available since SEMP API version 2.41. + +The import identifier for this resource is `{proxy_name}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + + + + +## Schema + +### Required + +- `proxy_name` (String) The name of the proxy. + +### 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_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: + +
+"none" - No authentication.
+"basic" - Username/password authentication.
+
+- `enabled` (Boolean) Enable or disable the proxy. When disabled, no connections are initiated to this particular proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. +- `host` (String) The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `""`. +- `port` (Number) The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. +- `proxy_type` (String) The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `"direct"`. The allowed values and their meaning are: + +
+"direct" - Direct connection (no proxy).
+"http" - HTTP proxy.
+
diff --git a/docs/resources/virtual_hostname.md b/docs/resources/virtual_hostname.md index 78d88968..dbe95117 100644 --- a/docs/resources/virtual_hostname.md +++ b/docs/resources/virtual_hostname.md @@ -3,19 +3,19 @@ page_title: "solacebroker_virtual_hostname Resource - solacebroker" subcategory: "" description: |- + This resource is not supported in production by Solace in this version, see provider limitations. A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. - Attribute|Identifying - :---|:---: - virtual_hostname|x A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.17. - The import identifier for this resource is {virtualHostname}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. + The import identifier for this resource is {virtual_hostname}, where {<attribute>} represents the value of the attribute and it must be URL-encoded. --- # solacebroker_virtual_hostname (Resource) +> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations). + A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping. Clients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname. @@ -23,17 +23,12 @@ Clients which connect to a global (as opposed to per Message VPN) port and provi This mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS. -Attribute|Identifying -:---|:---: -virtual_hostname|x - - A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation. This has been available since SEMP API version 2.17. -The import identifier for this resource is `{virtualHostname}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. +The import identifier for this resource is `{virtual_hostname}`, where {<attribute>} represents the value of the attribute and it must be URL-encoded. diff --git a/go.mod b/go.mod index 8dd8cd51..6c171461 100644 --- a/go.mod +++ b/go.mod @@ -1,17 +1,17 @@ module terraform-provider-solacebroker -go 1.22.2 +go 1.22.4 require ( - github.com/hashicorp/go-retryablehttp v0.7.5 - github.com/hashicorp/go-version v1.6.0 + github.com/hashicorp/go-retryablehttp v0.7.7 + github.com/hashicorp/go-version v1.7.0 github.com/hashicorp/terraform-plugin-docs v0.19.2 - github.com/hashicorp/terraform-plugin-framework v1.8.0 + github.com/hashicorp/terraform-plugin-framework v1.9.0 github.com/hashicorp/terraform-plugin-framework-validators v0.12.0 - github.com/hashicorp/terraform-plugin-go v0.22.2 + github.com/hashicorp/terraform-plugin-go v0.23.0 github.com/hashicorp/terraform-plugin-log v0.9.0 github.com/hashicorp/terraform-plugin-testing v1.7.0 - github.com/spf13/cobra v1.8.0 + github.com/spf13/cobra v1.8.1 github.com/testcontainers/testcontainers-go v0.30.0 ) @@ -40,7 +40,7 @@ require ( github.com/docker/docker v25.0.5+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.16.0 // indirect + github.com/fatih/color v1.17.0 // indirect github.com/felixge/httpsnoop v1.0.4 // indirect github.com/go-logr/logr v1.4.1 // indirect github.com/go-logr/stdr v1.2.2 // indirect @@ -56,7 +56,7 @@ require ( github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect github.com/hashicorp/go-hclog v1.6.3 // indirect github.com/hashicorp/go-multierror v1.1.1 // indirect - github.com/hashicorp/go-plugin v1.6.0 // indirect + github.com/hashicorp/go-plugin v1.6.1 // indirect github.com/hashicorp/go-uuid v1.0.3 // indirect github.com/hashicorp/hc-install v0.6.4 // indirect github.com/hashicorp/hcl/v2 v2.20.0 // indirect @@ -112,17 +112,18 @@ require ( go.opentelemetry.io/otel v1.24.0 // indirect go.opentelemetry.io/otel/metric v1.24.0 // indirect go.opentelemetry.io/otel/trace v1.24.0 // indirect - golang.org/x/crypto v0.22.0 // indirect + golang.org/x/crypto v0.24.0 // indirect golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df // indirect - golang.org/x/mod v0.16.0 // indirect - golang.org/x/net v0.24.0 // indirect - golang.org/x/sys v0.19.0 // indirect - golang.org/x/text v0.14.0 // indirect - golang.org/x/tools v0.13.0 // indirect + golang.org/x/mod v0.17.0 // indirect + golang.org/x/net v0.26.0 // indirect + golang.org/x/sync v0.7.0 // indirect + golang.org/x/sys v0.21.0 // indirect + golang.org/x/text v0.16.0 // indirect + 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-20240429193739-8cf5692501f6 // indirect - google.golang.org/grpc v1.63.2 // indirect - google.golang.org/protobuf v1.34.0 // indirect + google.golang.org/genproto/googleapis/rpc v0.0.0-20240610135401-a8a62080eff3 // indirect + google.golang.org/grpc v1.64.0 // 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 704b5786..ade347a2 100644 --- a/go.sum +++ b/go.sum @@ -43,7 +43,7 @@ github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I= github.com/containerd/log v0.1.0/go.mod h1:VRRf09a7mHDIRezVKTRCrOq78v577GXq3bSa3EhrzVo= github.com/cpuguy83/dockercfg v0.3.1 h1:/FpZ+JaygUR/lZP2NlFI2DVfrOEMAIKP5wWEJdoYe9E= github.com/cpuguy83/dockercfg v0.3.1/go.mod h1:sugsbF4//dDlL/i+S+rtpIWp+5h0BHJHfjj5/jFyUJc= -github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY= github.com/creack/pty v1.1.18/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= github.com/cyphar/filepath-securejoin v0.2.4 h1:Ugdm7cg7i6ZK6x3xDF1oEu1nfkyfH53EtKeQYTC3kyg= @@ -62,8 +62,8 @@ github.com/docker/go-units v0.5.0/go.mod h1:fgPhTUdO+D/Jk86RDLlptpiXQzgHJF7gydDD github.com/emirpasic/gods v1.18.1 h1:FXtiHYKDGKCW2KzwZKx0iC0PQmdlorYgdFG9jPXJ1Bc= github.com/emirpasic/gods v1.18.1/go.mod h1:8tpGGwCnJ5H4r6BWwaV6OrWmMoPhUl5jm/FMNAnJvWQ= github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk= -github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM= -github.com/fatih/color v1.16.0/go.mod h1:fL2Sau1YI5c0pdGEVCbKQbLXB6edEj1ZgiY4NijnWvE= +github.com/fatih/color v1.17.0 h1:GlRw1BRJxkpqUCBKzKOw098ed57fEsKeNjpTe3cSjK4= +github.com/fatih/color v1.17.0/go.mod h1:YZ7TlrGPkiz6ku9fK3TLD/pl3CpsiFyu8N92HLgmosI= github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg= github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U= github.com/frankban/quicktest v1.14.3 h1:FJKSZTDHjyhriyC81FLQ0LY93eSai0ZyR/ZIkd3ZUKE= @@ -115,21 +115,20 @@ github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9n github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 h1:1/D3zfFHttUKaCaGKZ/dR2roBXv0vKbSCnssIldfQdI= github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320/go.mod h1:EiZBMaudVLy8fmjf9Npq1dq9RalhveqZG5w/yz3mHWs= -github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k= github.com/hashicorp/go-hclog v1.6.3/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M= github.com/hashicorp/go-multierror v1.0.0/go.mod h1:dHtQlpGsu+cZNNAkkCN/P3hoUDHhCYQXV3UM06sGGrk= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= -github.com/hashicorp/go-plugin v1.6.0 h1:wgd4KxHJTVGGqWBq4QPB1i5BZNEx9BR8+OFmHDmTk8A= -github.com/hashicorp/go-plugin v1.6.0/go.mod h1:lBS5MtSSBZk0SHc66KACcjjlU6WzEVP/8pwz68aMkCI= -github.com/hashicorp/go-retryablehttp v0.7.5 h1:bJj+Pj19UZMIweq/iie+1u5YCdGrnxCT9yvm0e+Nd5M= -github.com/hashicorp/go-retryablehttp v0.7.5/go.mod h1:Jy/gPYAdjqffZ/yFGCFV2doI5wjtH1ewM9u8iYVjtX8= +github.com/hashicorp/go-plugin v1.6.1 h1:P7MR2UP6gNKGPp+y7EZw2kOiq4IR9WiqLvp0XOsVdwI= +github.com/hashicorp/go-plugin v1.6.1/go.mod h1:XPHFku2tFo3o3QKFgSYo+cghcUhw1NA1hZyMK0PWAw0= +github.com/hashicorp/go-retryablehttp v0.7.7 h1:C8hUCYzor8PIfXHa4UrZkU4VvK8o9ISHxT2Q8+VepXU= +github.com/hashicorp/go-retryablehttp v0.7.7/go.mod h1:pkQpWZeYWskR+D1tR2O5OcBFOxfA7DoAO6xtkuQnHTk= github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= github.com/hashicorp/go-uuid v1.0.3 h1:2gKiV6YVmrJ1i2CKKa9obLvRieoRGviZFL26PcT/Co8= github.com/hashicorp/go-uuid v1.0.3/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= -github.com/hashicorp/go-version v1.6.0 h1:feTTfFNnjP967rlCxM/I9g701jU+RN74YKx2mOkIeek= -github.com/hashicorp/go-version v1.6.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= +github.com/hashicorp/go-version v1.7.0 h1:5tqGy27NaOTB8yJKUZELlFAS/LTKJkrmONwQKeRZfjY= +github.com/hashicorp/go-version v1.7.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= github.com/hashicorp/hc-install v0.6.4 h1:QLqlM56/+SIIGvGcfFiwMY3z5WGXT066suo/v9Km8e0= github.com/hashicorp/hc-install v0.6.4/go.mod h1:05LWLy8TD842OtgcfBbOT0WMoInBMUSHjmDx10zuBIA= github.com/hashicorp/hcl/v2 v2.20.0 h1:l++cRs/5jQOiKVvqXZm/P1ZEfVXJmvLS9WSVxkaeTb4= @@ -142,12 +141,12 @@ github.com/hashicorp/terraform-json v0.21.0 h1:9NQxbLNqPbEMze+S6+YluEdXgJmhQykRy github.com/hashicorp/terraform-json v0.21.0/go.mod h1:qdeBs11ovMzo5puhrRibdD6d2Dq6TyE/28JiU4tIQxk= github.com/hashicorp/terraform-plugin-docs v0.19.2 h1:YjdKa1vuqt9EnPYkkrv9HnGZz175HhSJ7Vsn8yZeWus= github.com/hashicorp/terraform-plugin-docs v0.19.2/go.mod h1:gad2aP6uObFKhgNE8DR9nsEuEQnibp7il0jZYYOunWY= -github.com/hashicorp/terraform-plugin-framework v1.8.0 h1:P07qy8RKLcoBkCrY2RHJer5AEvJnDuXomBgou6fD8kI= -github.com/hashicorp/terraform-plugin-framework v1.8.0/go.mod h1:/CpTukO88PcL/62noU7cuyaSJ4Rsim+A/pa+3rUVufY= +github.com/hashicorp/terraform-plugin-framework v1.9.0 h1:caLcDoxiRucNi2hk8+j3kJwkKfvHznubyFsJMWfZqKU= +github.com/hashicorp/terraform-plugin-framework v1.9.0/go.mod h1:qBXLDn69kM97NNVi/MQ9qgd1uWWsVftGSnygYG1tImM= github.com/hashicorp/terraform-plugin-framework-validators v0.12.0 h1:HOjBuMbOEzl7snOdOoUfE2Jgeto6JOjLVQ39Ls2nksc= github.com/hashicorp/terraform-plugin-framework-validators v0.12.0/go.mod h1:jfHGE/gzjxYz6XoUwi/aYiiKrJDeutQNUtGQXkaHklg= -github.com/hashicorp/terraform-plugin-go v0.22.2 h1:5o8uveu6eZUf5J7xGPV0eY0TPXg3qpmwX9sce03Bxnc= -github.com/hashicorp/terraform-plugin-go v0.22.2/go.mod h1:drq8Snexp9HsbFZddvyLHN6LuWHHndSQg+gV+FPkcIM= +github.com/hashicorp/terraform-plugin-go v0.23.0 h1:AALVuU1gD1kPb48aPQUjug9Ir/125t+AAurhqphJ2Co= +github.com/hashicorp/terraform-plugin-go v0.23.0/go.mod h1:1E3Cr9h2vMlahWMbsSEcNrOCxovCZhOOIXjFHbjc/lQ= github.com/hashicorp/terraform-plugin-log v0.9.0 h1:i7hOA+vdAItN1/7UrfBqBwvYPQ9TFvymaRGZED3FCV0= github.com/hashicorp/terraform-plugin-log v0.9.0/go.mod h1:rKL8egZQ/eXSyDqzLUuwUYLVdlYeamldAHSxjUFADow= github.com/hashicorp/terraform-plugin-sdk/v2 v2.33.0 h1:qHprzXy/As0rxedphECBEQAh3R4yp6pKksKHcqZx5G8= @@ -260,8 +259,8 @@ github.com/skeema/knownhosts v1.2.2/go.mod h1:xYbVRSPxqBZFrdmDyMmsOs+uX1UZC3nTN3 github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= github.com/spf13/cast v1.5.0 h1:rj3WzYc11XZaIZMPKmwP96zkFEnnAmV8s6XbB2aY32w= github.com/spf13/cast v1.5.0/go.mod h1:SpXXQ5YoyJw6s3/6cMTQuxvgRl3PCJiyaX9p6b155UU= -github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= -github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= +github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM= +github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= @@ -326,15 +325,15 @@ golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8U golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.3.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= -golang.org/x/crypto v0.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30= -golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M= +golang.org/x/crypto v0.24.0 h1:mnl8DM0o513X8fdIkmyFE/5hTYxbwYOjDS/+rK6qpRI= +golang.org/x/crypto v0.24.0/go.mod h1:Z1PMYSOR5nyMcyAVAIQSKCDwalqy85Aqn1x3Ws4L5DM= golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df h1:UA2aFVmmsIlefxMk29Dp2juaUSth8Pyn3Tq5Y5mJGME= golang.org/x/exp v0.0.0-20230626212559-97b1e661b5df/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc= golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic= -golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -342,15 +341,15 @@ golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwY golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= -golang.org/x/net v0.24.0 h1:1PcaxkF854Fu3+lvBIx5SYn9wRlBzzcnHZSiaFFAb0w= -golang.org/x/net v0.24.0/go.mod h1:2Q7sJY5mzlzWjKtYUEXSlBWCdyaioyXzRB2RtU8KVE8= +golang.org/x/net v0.26.0 h1:soB7SVo0PWrY4vPW/+ay0jKDNScG2X9wFeYlXIvJsOQ= +golang.org/x/net v0.26.0/go.mod h1:5YKkiSynbBIh3p6iOc/vibscux0x38BZDkn8sCUPxHE= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ= -golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M= +golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -373,8 +372,8 @@ golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o= -golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.21.0 h1:rF+pYz3DAGSQAxAu1CbC7catZg4ebC4UIeIhKxBZvws= +golang.org/x/sys v0.21.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= @@ -384,8 +383,8 @@ golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= -golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4= +golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI= golang.org/x/time v0.3.0 h1:rg5rLMjNzMS1RkNLzCG38eapWhnYLFYXDXj2gOlr8j4= golang.org/x/time v0.3.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= @@ -393,8 +392,8 @@ golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtn golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE= golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.13.0 h1:Iey4qkscZuv0VvIt8E0neZjtPVQFSc870HQ448QgEmQ= -golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d h1:vU5i/LfpvrRCpgM/VPfJLg5KjxD3E+hfT1SH+d9zLwg= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -402,17 +401,17 @@ golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8T google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= google.golang.org/appengine v1.6.8 h1:IhEN5q69dyKagZPYMSdIjS2HqprW324FRQZJcGqPAsM= google.golang.org/appengine v1.6.8/go.mod h1:1jJ3jBArFh5pcgW8gCtRJnepW8FzD1V44FJffLiz/Ds= -google.golang.org/genproto v0.0.0-20240227224415-6ceb2ff114de h1:F6qOa9AZTYJXOUEr4jDysRDLrm4PHePlge4v4TGAlxY= -google.golang.org/genproto/googleapis/api v0.0.0-20240227224415-6ceb2ff114de h1:jFNzHPIeuzhdRwVhbZdiym9q0ory/xY3sA+v2wPg8I0= -google.golang.org/genproto/googleapis/api v0.0.0-20240227224415-6ceb2ff114de/go.mod h1:5iCWqnniDlqZHrd3neWVTOwvh/v6s3232omMecelax8= -google.golang.org/genproto/googleapis/rpc v0.0.0-20240429193739-8cf5692501f6 h1:DujSIu+2tC9Ht0aPNA7jgj23Iq8Ewi5sgkQ++wdvonE= -google.golang.org/genproto/googleapis/rpc v0.0.0-20240429193739-8cf5692501f6/go.mod h1:WtryC6hu0hhx87FDGxWCDptyssuo68sk10vYjF+T9fY= -google.golang.org/grpc v1.63.2 h1:MUeiw1B2maTVZthpU5xvASfTh3LDbxHd6IJ6QQVU+xM= -google.golang.org/grpc v1.63.2/go.mod h1:WAX/8DgncnokcFUldAxq7GeB5DXHDbMF+lLvDomNkRA= +google.golang.org/genproto v0.0.0-20230711160842-782d3b101e98 h1:Z0hjGZePRE0ZBWotvtrwxFNrNE9CUAGtplaDK5NNI/g= +google.golang.org/genproto/googleapis/api v0.0.0-20240318140521-94a12d6c2237 h1:RFiFrvy37/mpSpdySBDrUdipW/dHwsRwh3J3+A9VgT4= +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/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.0 h1:Qo/qEd2RZPCf2nKuorzksSknv0d3ERwp1vFG38gSmH4= -google.golang.org/protobuf v1.34.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= +google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg= +google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= diff --git a/internal/broker/generated/AboutUserMsgVpn.go b/internal/broker/generated/AboutUserMsgVpn.go index 44b73b14..7aab0b4f 100644 --- a/internal/broker/generated/AboutUserMsgVpn.go +++ b/internal/broker/generated/AboutUserMsgVpn.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "about_user_msg_vpn", - MarkdownDescription: "This provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "This provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/none\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.DataSourceObject, PathTemplate: "/about/user/msgVpns/{msgVpnName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/Broker.go b/internal/broker/generated/Broker.go index 1ec38ff6..994f3329 100644 --- a/internal/broker/generated/Broker.go +++ b/internal/broker/generated/Broker.go @@ -30,11 +30,21 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "broker", - MarkdownDescription: "This object contains global configuration for the message broker.\n\n\nAttribute|Write-Only|Opaque\n:---|:---:|:---:\ntls_server_cert_content|x|x\ntls_server_cert_password|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauth_client_cert_revocation_check_mode|global/read-only\nconfig_sync_authentication_client_cert_max_chain_depth|global/read-only\nconfig_sync_authentication_client_cert_validate_date_enabled|global/read-only\nconfig_sync_client_profile_tcp_initial_congestion_window|global/read-only\nconfig_sync_client_profile_tcp_keepalive_count|global/read-only\nconfig_sync_client_profile_tcp_keepalive_idle|global/read-only\nconfig_sync_client_profile_tcp_keepalive_interval|global/read-only\nconfig_sync_client_profile_tcp_max_window|global/read-only\nconfig_sync_client_profile_tcp_mss|global/read-only\nconfig_sync_enabled|global/read-only\nconfig_sync_synchronize_username_enabled|global/read-only\nconfig_sync_tls_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_day_list|global/read-only\nguaranteed_msging_defragmentation_schedule_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_time_list|global/read-only\nguaranteed_msging_defragmentation_threshold_enabled|global/read-only\nguaranteed_msging_defragmentation_threshold_fragmentation_percentage|global/read-only\nguaranteed_msging_defragmentation_threshold_min_interval|global/read-only\nguaranteed_msging_defragmentation_threshold_usage_percentage|global/read-only\nguaranteed_msging_enabled|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.clear_percent|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.set_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_msg_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_value|global/read-only\nguaranteed_msging_max_cache_usage|global/read-only\nguaranteed_msging_max_msg_spool_usage|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_msg_ack_timeout|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_spool_file_ack_timeout|global/read-only\nguaranteed_msging_transaction_replication_compatibility_mode|global/read-only\noauth_profile_default|global/read-only\nservice_amqp_enabled|global/read-only\nservice_amqp_tls_listen_port|global/read-only\nservice_event_connection_count_threshold.clear_percent|global/read-only\nservice_event_connection_count_threshold.clear_value|global/read-only\nservice_event_connection_count_threshold.set_percent|global/read-only\nservice_event_connection_count_threshold.set_value|global/read-only\nservice_health_check_enabled|global/read-only\nservice_health_check_listen_port|global/read-only\nservice_health_check_tls_enabled|global/read-only\nservice_health_check_tls_listen_port|global/read-only\nservice_mate_link_enabled|global/read-only\nservice_mate_link_listen_port|global/read-only\nservice_mqtt_enabled|global/read-only\nservice_msg_backbone_enabled|global/read-only\nservice_redundancy_enabled|global/read-only\nservice_redundancy_first_listen_port|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_value|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_value|global/read-only\nservice_rest_incoming_enabled|global/read-only\nservice_rest_outgoing_enabled|global/read-only\nservice_semp_cors_allow_any_host_enabled|global/read-only\nservice_semp_legacy_timeout_enabled|global/read-only\nservice_semp_plain_text_enabled|global/read-only\nservice_semp_plain_text_listen_port|global/read-only\nservice_semp_session_idle_timeout|global/read-only\nservice_semp_session_max_lifetime|global/read-only\nservice_semp_tls_enabled|global/read-only\nservice_semp_tls_listen_port|global/read-only\nservice_smf_compression_listen_port|global/read-only\nservice_smf_enabled|global/read-only\nservice_smf_event_connection_count_threshold.clear_percent|global/read-only\nservice_smf_event_connection_count_threshold.clear_value|global/read-only\nservice_smf_event_connection_count_threshold.set_percent|global/read-only\nservice_smf_event_connection_count_threshold.set_value|global/read-only\nservice_smf_plain_text_listen_port|global/read-only\nservice_smf_routing_control_listen_port|global/read-only\nservice_smf_tls_listen_port|global/read-only\nservice_tls_event_connection_count_threshold.clear_percent|global/read-only\nservice_tls_event_connection_count_threshold.clear_value|global/read-only\nservice_tls_event_connection_count_threshold.set_percent|global/read-only\nservice_tls_event_connection_count_threshold.set_value|global/read-only\nservice_web_transport_enabled|global/read-only\nservice_web_transport_plain_text_listen_port|global/read-only\nservice_web_transport_tls_listen_port|global/read-only\nservice_web_transport_web_url_suffix|global/read-only\ntls_block_version11_enabled|global/read-only\ntls_cipher_suite_management_list|global/read-only\ntls_cipher_suite_msg_backbone_list|global/read-only\ntls_cipher_suite_secure_shell_list|global/read-only\ntls_crime_exploit_protection_enabled|global/read-only\ntls_server_cert_content|global/read-only\ntls_ticket_lifetime|global/read-only\n\n\n\nThis has been available since SEMP API version 2.13.", + MarkdownDescription: "This object contains global configuration for the message broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation. Requests which include the following attributes may require greater access scope/level than \"vpn/read-only\":\n\n\nAttribute|Access Scope/Level\n:---|:---:\nauth_brute_force_protection_enabled|global/read-only\nauth_client_cert_revocation_check_mode|global/read-only\nconfig_sync_authentication_client_cert_max_chain_depth|global/read-only\nconfig_sync_authentication_client_cert_validate_date_enabled|global/read-only\nconfig_sync_client_profile_tcp_initial_congestion_window|global/read-only\nconfig_sync_client_profile_tcp_keepalive_count|global/read-only\nconfig_sync_client_profile_tcp_keepalive_idle|global/read-only\nconfig_sync_client_profile_tcp_keepalive_interval|global/read-only\nconfig_sync_client_profile_tcp_max_window|global/read-only\nconfig_sync_client_profile_tcp_mss|global/read-only\nconfig_sync_enabled|global/read-only\nconfig_sync_synchronize_username_enabled|global/read-only\nconfig_sync_tls_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_day_list|global/read-only\nguaranteed_msging_defragmentation_schedule_enabled|global/read-only\nguaranteed_msging_defragmentation_schedule_time_list|global/read-only\nguaranteed_msging_defragmentation_threshold_enabled|global/read-only\nguaranteed_msging_defragmentation_threshold_fragmentation_percentage|global/read-only\nguaranteed_msging_defragmentation_threshold_min_interval|global/read-only\nguaranteed_msging_defragmentation_threshold_usage_percentage|global/read-only\nguaranteed_msging_enabled|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_cache_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.clear_percent|global/read-only\nguaranteed_msging_event_delivered_unacked_threshold.set_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_disk_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_egress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_endpoint_count_threshold.set_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_ingress_flow_count_threshold.set_value|global/read-only\nguaranteed_msging_event_msg_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_file_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.clear_value|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_percent|global/read-only\nguaranteed_msging_event_msg_spool_usage_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transacted_session_count_threshold.set_value|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transacted_session_resource_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.clear_value|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_percent|global/read-only\nguaranteed_msging_event_transaction_count_threshold.set_value|global/read-only\nguaranteed_msging_max_cache_usage|global/read-only\nguaranteed_msging_max_msg_spool_usage|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_msg_ack_timeout|global/read-only\nguaranteed_msging_msg_spool_sync_mirrored_spool_file_ack_timeout|global/read-only\nguaranteed_msging_transaction_replication_compatibility_mode|global/read-only\noauth_profile_default|global/read-only\nservice_amqp_enabled|global/read-only\nservice_amqp_tls_listen_port|global/read-only\nservice_event_connection_count_threshold.clear_percent|global/read-only\nservice_event_connection_count_threshold.clear_value|global/read-only\nservice_event_connection_count_threshold.set_percent|global/read-only\nservice_event_connection_count_threshold.set_value|global/read-only\nservice_health_check_enabled|global/read-only\nservice_health_check_listen_port|global/read-only\nservice_health_check_tls_enabled|global/read-only\nservice_health_check_tls_listen_port|global/read-only\nservice_mate_link_enabled|global/read-only\nservice_mate_link_listen_port|global/read-only\nservice_mqtt_enabled|global/read-only\nservice_msg_backbone_enabled|global/read-only\nservice_redundancy_enabled|global/read-only\nservice_redundancy_first_listen_port|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.clear_value|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_percent|global/read-only\nservice_rest_event_outgoing_connection_count_threshold.set_value|global/read-only\nservice_rest_incoming_enabled|global/read-only\nservice_rest_outgoing_enabled|global/read-only\nservice_semp_cors_allow_any_host_enabled|global/read-only\nservice_semp_legacy_timeout_enabled|global/read-only\nservice_semp_plain_text_enabled|global/read-only\nservice_semp_plain_text_listen_port|global/read-only\nservice_semp_session_idle_timeout|global/read-only\nservice_semp_session_max_lifetime|global/read-only\nservice_semp_tls_enabled|global/read-only\nservice_semp_tls_listen_port|global/read-only\nservice_smf_compression_listen_port|global/read-only\nservice_smf_enabled|global/read-only\nservice_smf_event_connection_count_threshold.clear_percent|global/read-only\nservice_smf_event_connection_count_threshold.clear_value|global/read-only\nservice_smf_event_connection_count_threshold.set_percent|global/read-only\nservice_smf_event_connection_count_threshold.set_value|global/read-only\nservice_smf_plain_text_listen_port|global/read-only\nservice_smf_routing_control_listen_port|global/read-only\nservice_smf_tls_listen_port|global/read-only\nservice_tls_event_connection_count_threshold.clear_percent|global/read-only\nservice_tls_event_connection_count_threshold.clear_value|global/read-only\nservice_tls_event_connection_count_threshold.set_percent|global/read-only\nservice_tls_event_connection_count_threshold.set_value|global/read-only\nservice_web_transport_enabled|global/read-only\nservice_web_transport_plain_text_listen_port|global/read-only\nservice_web_transport_tls_listen_port|global/read-only\nservice_web_transport_web_url_suffix|global/read-only\ntls_block_version11_enabled|global/read-only\ntls_cipher_suite_management_list|global/read-only\ntls_cipher_suite_msg_backbone_list|global/read-only\ntls_cipher_suite_secure_shell_list|global/read-only\ntls_crime_exploit_protection_enabled|global/read-only\ntls_server_cert_content|global/read-only\ntls_ticket_lifetime|global/read-only\n\n\n\nThis has been available since SEMP API version 2.13.", ObjectType: broker.SingletonObject, PathTemplate: "/", Version: 0, // Placeholder: value will be replaced in the provider code Attributes: []*broker.AttributeInfo{ + { + BaseType: broker.Bool, + SempName: "authBruteForceProtectionEnabled", + TerraformName: "auth_brute_force_protection_enabled", + MarkdownDescription: "Enable or disable protection against brute force password guessing attacks on local management accounts. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since SEMP API version 2.40.", + Type: types.BoolType, + TerraformType: tftypes.Bool, + Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, + Default: true, + }, { BaseType: broker.String, SempName: "authClientCertRevocationCheckMode", @@ -272,7 +282,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Struct, @@ -1229,7 +1239,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Int64, @@ -1346,7 +1356,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Int64, @@ -1369,7 +1379,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Int64, @@ -1382,7 +1392,7 @@ func init() { Int64Validators: []validator.Int64{ int64validator.Between(0, 65535), }, - Default: 0, + Default: 5553, }, { BaseType: broker.Bool, @@ -1415,7 +1425,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Bool, @@ -1552,7 +1562,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Bool, @@ -1562,7 +1572,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Bool, @@ -1572,7 +1582,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: true, + Default: false, }, { BaseType: broker.Bool, @@ -1888,7 +1898,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.Int64, @@ -1937,7 +1947,7 @@ func init() { Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, - Default: false, + Default: true, }, { BaseType: broker.String, diff --git a/internal/broker/generated/ClientCertAuthority.go b/internal/broker/generated/ClientCertAuthority.go index 23580602..1f8fc396 100644 --- a/internal/broker/generated/ClientCertAuthority.go +++ b/internal/broker/generated/ClientCertAuthority.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "client_cert_authority", - MarkdownDescription: "Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncert_authority_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", + MarkdownDescription: "Clients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", ObjectType: broker.StandardObject, PathTemplate: "/clientCertAuthorities/{certAuthorityName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go b/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go index a2159169..e6f4b8c6 100644 --- a/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go +++ b/internal/broker/generated/ClientCertAuthorityOcspTlsTrustedCommonName.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "client_cert_authority_ocsp_tls_trusted_common_name", - MarkdownDescription: "When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\nAttribute|Identifying\n:---|:---:\ncert_authority_name|x\nocsp_tls_trusted_common_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", + MarkdownDescription: "When an OCSP override URL is configured, the OCSP responder will be required to sign the OCSP responses with certificates issued to these Trusted Common Names. A maximum of 8 common names can be configured as valid response signers.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames/{ocspTlsTrustedCommonName}", PostPathTemplate: "/clientCertAuthorities/{certAuthorityName}/ocspTlsTrustedCommonNames", diff --git a/internal/broker/generated/DmrCluster.go b/internal/broker/generated/DmrCluster.go index c7e781d6..82b9b76e 100644 --- a/internal/broker/generated/DmrCluster.go +++ b/internal/broker/generated/DmrCluster.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster", - MarkdownDescription: "A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\nAttribute|Identifying|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthentication_basic_password||x||x\nauthentication_client_cert_content||x||x\nauthentication_client_cert_password||x||\ndmr_cluster_name|x|||\ntls_server_cert_enforce_trusted_common_name_enabled|||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Cluster is a provisioned object on a message broker that contains global DMR configuration parameters.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/dmrClusters/{dmrClusterName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/DmrClusterCertMatchingRule.go b/internal/broker/generated/DmrClusterCertMatchingRule.go index d57791fa..f7794b96 100644 --- a/internal/broker/generated/DmrClusterCertMatchingRule.go +++ b/internal/broker/generated/DmrClusterCertMatchingRule.go @@ -27,7 +27,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_cert_matching_rule", - MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given link.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.StandardObject, PathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go b/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go index 474b0dfb..c4d53ae9 100644 --- a/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go +++ b/internal/broker/generated/DmrClusterCertMatchingRuleAttributeFilter.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_cert_matching_rule_attribute_filter", - MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nfilter_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a link attribute to a string.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.StandardObject, PathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go b/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go index fff95b88..ea2d072f 100644 --- a/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go +++ b/internal/broker/generated/DmrClusterCertMatchingRuleCondition.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_cert_matching_rule_condition", - MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nrule_name|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a link attribute or an expression.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions/{source}", PostPathTemplate: "/dmrClusters/{dmrClusterName}/certMatchingRules/{ruleName}/conditions", diff --git a/internal/broker/generated/DmrClusterLink.go b/internal/broker/generated/DmrClusterLink.go index 1304a957..1694539c 100644 --- a/internal/broker/generated/DmrClusterLink.go +++ b/internal/broker/generated/DmrClusterLink.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_link", - MarkdownDescription: "A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\ndmr_cluster_name|x||\nremote_node_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Link connects nodes (either within a Cluster or between two different Clusters) and allows them to exchange topology information, subscriptions and data.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -270,6 +270,32 @@ func init() { }, Default: 256, }, + { + BaseType: broker.Int64, + SempName: "connectionRetryCount", + TerraformName: "connection_retry_count", + MarkdownDescription: "The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since SEMP API version 2.41.", + Type: types.Int64Type, + TerraformType: tftypes.Number, + Converter: broker.IntegerConverter{}, + Int64Validators: []validator.Int64{ + int64validator.Between(0, 255), + }, + Default: 0, + }, + { + BaseType: broker.Int64, + SempName: "connectionRetryDelay", + TerraformName: "connection_retry_delay", + MarkdownDescription: "The number of seconds the broker waits for the bridge connection to be established before attempting a new connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`. Available since SEMP API version 2.41.", + Type: types.Int64Type, + TerraformType: tftypes.Number, + Converter: broker.IntegerConverter{}, + Int64Validators: []validator.Int64{ + int64validator.Between(0, 255), + }, + Default: 3, + }, { BaseType: broker.String, SempName: "dmrClusterName", diff --git a/internal/broker/generated/DmrClusterLinkAttribute.go b/internal/broker/generated/DmrClusterLinkAttribute.go index 3e51974d..54080f46 100644 --- a/internal/broker/generated/DmrClusterLinkAttribute.go +++ b/internal/broker/generated/DmrClusterLinkAttribute.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_link_attribute", - MarkdownDescription: "A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattribute_name|x\nattribute_value|x\ndmr_cluster_name|x\nremote_node_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Link Attribute is a key+value pair that can be used to locate a DMR Cluster Link, for example when using client certificate mapping.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes/{attributeName},{attributeValue}", PostPathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/attributes", diff --git a/internal/broker/generated/DmrClusterLinkRemoteAddress.go b/internal/broker/generated/DmrClusterLinkRemoteAddress.go index c3a180ce..065923e3 100644 --- a/internal/broker/generated/DmrClusterLinkRemoteAddress.go +++ b/internal/broker/generated/DmrClusterLinkRemoteAddress.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "dmr_cluster_link_remote_address", - MarkdownDescription: "Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\nAttribute|Identifying\n:---|:---:\ndmr_cluster_name|x\nremote_address|x\nremote_node_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "Each Remote Address, consisting of a FQDN or IP address and optional port, is used to connect to the remote node for this Link. Up to 4 addresses may be provided for each Link, and will be tried on a round-robin basis.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses/{remoteAddress}", PostPathTemplate: "/dmrClusters/{dmrClusterName}/links/{remoteNodeName}/remoteAddresses", @@ -63,7 +63,7 @@ func init() { Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, StringValidators: []validator.String{ stringvalidator.LengthBetween(1, 259), - stringvalidator.RegexMatches(regexp.MustCompile("^((([0-9a-zA-Z_\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})$"), ""), + stringvalidator.RegexMatches(regexp.MustCompile("^((([0-9a-zA-Z_\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})$"), ""), }, }, { diff --git a/internal/broker/generated/DomainCertAuthority.go b/internal/broker/generated/DomainCertAuthority.go index d5fa86eb..abf6629e 100644 --- a/internal/broker/generated/DomainCertAuthority.go +++ b/internal/broker/generated/DomainCertAuthority.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "domain_cert_authority", - MarkdownDescription: "Certificate Authorities trusted for domain verification.\n\n\nAttribute|Identifying\n:---|:---:\ncert_authority_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", + MarkdownDescription: "Certificate Authorities trusted for domain verification.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.19.", ObjectType: broker.StandardObject, PathTemplate: "/domainCertAuthorities/{certAuthorityName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpn.go b/internal/broker/generated/MsgVpn.go index 8edac5ae..d6c5caa5 100644 --- a/internal/broker/generated/MsgVpn.go +++ b/internal/broker/generated/MsgVpn.go @@ -31,7 +31,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn", - MarkdownDescription: "Message 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|Write-Only|Deprecated|Opaque\n:---|:---:|:---:|:---:|:---:\nauthentication_oauth_default_provider_name|||x|\nbridging_tls_server_cert_enforce_trusted_common_name_enabled|||x|\ndistributed_cache_management_enabled|||x|\nmsg_vpn_name|x|||\nreplication_bridge_authentication_basic_password||x||x\nreplication_bridge_authentication_client_cert_content||x||x\nreplication_bridge_authentication_client_cert_password||x||\nreplication_enabled_queue_behavior||x||\nrest_tls_server_cert_enforce_trusted_common_name_enabled|||x|\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: "Message 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\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -107,7 +107,7 @@ func init() { BaseType: broker.Bool, SempName: "authenticationClientCertAllowApiProvidedUsernameEnabled", TerraformName: "authentication_client_cert_allow_api_provided_username_enabled", - MarkdownDescription: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, @@ -127,7 +127,7 @@ func init() { BaseType: broker.Bool, SempName: "authenticationClientCertEnabled", TerraformName: "authentication_client_cert_enabled", - MarkdownDescription: "Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable client certificate authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, @@ -186,7 +186,7 @@ func init() { BaseType: broker.Bool, SempName: "authenticationKerberosAllowApiProvidedUsernameEnabled", TerraformName: "authentication_kerberos_allow_api_provided_username_enabled", - MarkdownDescription: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable allowing an incoming client connection to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, @@ -196,7 +196,7 @@ func init() { BaseType: broker.Bool, SempName: "authenticationKerberosEnabled", TerraformName: "authentication_kerberos_enabled", - MarkdownDescription: "Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable Kerberos authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, @@ -220,7 +220,7 @@ func init() { BaseType: broker.Bool, SempName: "authenticationOauthEnabled", TerraformName: "authentication_oauth_enabled", - MarkdownDescription: "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13.", + MarkdownDescription: "Enable or disable OAuth authentication for clients connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since SEMP API version 2.13.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, @@ -1830,13 +1830,14 @@ func init() { BaseType: broker.Int64, SempName: "maxSubscriptionCount", TerraformName: "max_subscription_count", - MarkdownDescription: "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.", + MarkdownDescription: "The maximum number of local subscriptions that can be added to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `500000`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, Int64Validators: []validator.Int64{ int64validator.Between(0, 4294967295), }, + Default: 500000, }, { BaseType: broker.Int64, diff --git a/internal/broker/generated/MsgVpnAclProfile.go b/internal/broker/generated/MsgVpnAclProfile.go index 35469862..d85bb908 100644 --- a/internal/broker/generated/MsgVpnAclProfile.go +++ b/internal/broker/generated/MsgVpnAclProfile.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile", - MarkdownDescription: "An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "An ACL Profile controls whether an authenticated client is permitted to establish a connection with the message broker or permitted to publish and subscribe to specific topics.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnAclProfileClientConnectException.go b/internal/broker/generated/MsgVpnAclProfileClientConnectException.go index ec84be6a..5a59bd6c 100644 --- a/internal/broker/generated/MsgVpnAclProfileClientConnectException.go +++ b/internal/broker/generated/MsgVpnAclProfileClientConnectException.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_client_connect_exception", - MarkdownDescription: "A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nclient_connect_exception_address|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Client Connect Exception is an exception to the default action to take when a client using the ACL Profile connects to the Message VPN. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions/{clientConnectExceptionAddress}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/clientConnectExceptions", diff --git a/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go b/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go index 83d37215..04df08e3 100644 --- a/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go +++ b/internal/broker/generated/MsgVpnAclProfilePublishTopicException.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_publish_topic_exception", - MarkdownDescription: "A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\npublish_topic_exception|x\npublish_topic_exception_syntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Publish Topic Exception is an exception to the default action to take when a client using the ACL Profile publishes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions/{publishTopicExceptionSyntax},{publishTopicException}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/publishTopicExceptions", diff --git a/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go b/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go index 7e4c7493..f71ce981 100644 --- a/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go +++ b/internal/broker/generated/MsgVpnAclProfileSubscribeShareNameException.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_subscribe_share_name_exception", - MarkdownDescription: "A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\nsubscribe_share_name_exception|x\nsubscribe_share_name_exception_syntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Subscribe Share Name Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a share-name subscription in the Message VPN. Exceptions must be expressed as a topic.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions/{subscribeShareNameExceptionSyntax},{subscribeShareNameException}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeShareNameExceptions", diff --git a/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go b/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go index 904966b0..a74d90e7 100644 --- a/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go +++ b/internal/broker/generated/MsgVpnAclProfileSubscribeTopicException.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_acl_profile_subscribe_topic_exception", - MarkdownDescription: "A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\nAttribute|Identifying\n:---|:---:\nacl_profile_name|x\nmsg_vpn_name|x\nsubscribe_topic_exception|x\nsubscribe_topic_exception_syntax|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Subscribe Topic Exception is an exception to the default action to take when a client using the ACL Profile subscribes to a topic in the Message VPN. Exceptions must be expressed as a topic.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions/{subscribeTopicExceptionSyntax},{subscribeTopicException}", PostPathTemplate: "/msgVpns/{msgVpnName}/aclProfiles/{aclProfileName}/subscribeTopicExceptions", diff --git a/internal/broker/generated/MsgVpnAuthenticationKerberosRealm.go b/internal/broker/generated/MsgVpnAuthenticationKerberosRealm.go new file mode 100644 index 00000000..cb3473be --- /dev/null +++ b/internal/broker/generated/MsgVpnAuthenticationKerberosRealm.go @@ -0,0 +1,97 @@ +// terraform-provider-solacebroker +// +// Copyright 2024 Solace Corporation. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package generated + +import ( + "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator" + "github.com/hashicorp/terraform-plugin-framework/schema/validator" + "github.com/hashicorp/terraform-plugin-framework/types" + "github.com/hashicorp/terraform-plugin-go/tftypes" + "regexp" + "terraform-provider-solacebroker/internal/broker" +) + +func init() { + info := broker.EntityInputs{ + TerraformName: "msg_vpn_authentication_kerberos_realm", + MarkdownDescription: "Kerberos Realm.\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.40.", + ObjectType: broker.StandardObject, + PathTemplate: "/msgVpns/{msgVpnName}/authenticationKerberosRealms/{kerberosRealmName}", + Version: 0, // Placeholder: value will be replaced in the provider code + Attributes: []*broker.AttributeInfo{ + { + BaseType: broker.Bool, + SempName: "enabled", + TerraformName: "enabled", + MarkdownDescription: "Enable or disable the Realm. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.", + Type: types.BoolType, + TerraformType: tftypes.Bool, + Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, + Default: false, + }, + { + BaseType: broker.String, + SempName: "kdcAddress", + TerraformName: "kdc_address", + MarkdownDescription: "Address (FQDN or IP) and optional port of the Key Distribution Center for principals in this 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 `\"\"`.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 259), + stringvalidator.RegexMatches(regexp.MustCompile("^(((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1}))?$"), ""), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "kerberosRealmName", + TerraformName: "kerberos_realm_name", + MarkdownDescription: "The Realm Name. Must start with \"@\", typically all uppercase.", + Identifying: true, + Required: true, + RequiresReplace: true, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(2, 254), + stringvalidator.RegexMatches(regexp.MustCompile("^@.+$"), ""), + }, + }, + { + BaseType: broker.String, + SempName: "msgVpnName", + TerraformName: "msg_vpn_name", + MarkdownDescription: "The name of the Message VPN.", + Identifying: true, + Required: true, + ReadOnly: true, + RequiresReplace: true, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(1, 32), + stringvalidator.RegexMatches(regexp.MustCompile("^[^*?]+$"), ""), + }, + }, + }, + } + broker.RegisterResource(info) + broker.RegisterDataSource(info) +} diff --git a/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go b/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go index 9ebd3213..cb0e6199 100644 --- a/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go +++ b/internal/broker/generated/MsgVpnAuthenticationOauthProfile.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authentication_oauth_profile", - MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclient_secret||x|x\nmsg_vpn_name|x||\noauth_profile_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", + MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -303,6 +303,19 @@ func init() { }, Default: "client", }, + { + BaseType: broker.String, + SempName: "proxyName", + TerraformName: "proxy_name", + MarkdownDescription: "The name of the proxy to use for discovery, user info, jwks, and introspection requests. 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.41.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 32), + }, + Default: "", + }, { BaseType: broker.Bool, SempName: "resourceServerParseAccessTokenEnabled", diff --git a/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go b/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go index b9234153..1f15c1ed 100644 --- a/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go +++ b/internal/broker/generated/MsgVpnAuthenticationOauthProfileClientRequiredClaim.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authentication_oauth_profile_client_required_claim", - MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclient_required_claim_name|x\nmsg_vpn_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", + MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", PostPathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clientRequiredClaims", diff --git a/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go b/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go index b275d740..121e6b7b 100644 --- a/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go +++ b/internal/broker/generated/MsgVpnAuthenticationOauthProfileResourceServerRequiredClaim.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authentication_oauth_profile_resource_server_required_claim", - MarkdownDescription: "Additional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\noauth_profile_name|x\nresource_server_required_claim_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", + MarkdownDescription: "Additional claims to be verified in the access token.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.25.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", PostPathTemplate: "/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", diff --git a/internal/broker/generated/MsgVpnAuthorizationGroup.go b/internal/broker/generated/MsgVpnAuthorizationGroup.go index 417ceeb9..fba7d26a 100644 --- a/internal/broker/generated/MsgVpnAuthorizationGroup.go +++ b/internal/broker/generated/MsgVpnAuthorizationGroup.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_authorization_group", - MarkdownDescription: "To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\nAttribute|Identifying|Write-Only\n:---|:---:|:---:\nauthorization_group_name|x|\nmsg_vpn_name|x|\norder_after_authorization_group_name||x\norder_before_authorization_group_name||x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "To use client authorization groups configured on an external server to provide client authorizations, Authorization Group objects must be created on the Message VPN that match the authorization groups provisioned on the external server. These objects must be configured with the client profiles and ACL profiles that will be assigned to the clients that belong to those authorization groups. A newly created group is placed at the end of the group list which is the lowest priority.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/authorizationGroups/{authorizationGroupName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnBridge.go b/internal/broker/generated/MsgVpnBridge.go index 210ddf59..3c5f9d1f 100644 --- a/internal/broker/generated/MsgVpnBridge.go +++ b/internal/broker/generated/MsgVpnBridge.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_bridge", - MarkdownDescription: "Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridge_name|x||\nbridge_virtual_router|x||\nmsg_vpn_name|x||\nremote_authentication_basic_password||x|x\nremote_authentication_client_cert_content||x|x\nremote_authentication_client_cert_password||x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "Bridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -191,7 +191,7 @@ func init() { BaseType: broker.Int64, SempName: "remoteConnectionRetryCount", TerraformName: "remote_connection_retry_count", - MarkdownDescription: "The maximum number of retry attempts to establish a connection to the remote Message VPN. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", + MarkdownDescription: "The number of retry attempts to establish a connection before moving on to the next remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.", Type: types.Int64Type, TerraformType: tftypes.Number, Converter: broker.IntegerConverter{}, diff --git a/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go b/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go index 63eae0f3..e5f4eaa7 100644 --- a/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go +++ b/internal/broker/generated/MsgVpnBridgeRemoteMsgVpn.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_bridge_remote_msg_vpn", - MarkdownDescription: "The Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nbridge_name|x||\nbridge_virtual_router|x||\nmsg_vpn_name|x||\npassword||x|x\nremote_msg_vpn_interface|x||\nremote_msg_vpn_location|x||\nremote_msg_vpn_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "The Remote Message VPN is the Message VPN that the Bridge connects to.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteMsgVpns/{remoteMsgVpnName},{remoteMsgVpnLocation},{remoteMsgVpnInterface}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go b/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go index 800ed51c..97f5e7bb 100644 --- a/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go +++ b/internal/broker/generated/MsgVpnBridgeRemoteSubscription.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_bridge_remote_subscription", - MarkdownDescription: "A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\nAttribute|Identifying\n:---|:---:\nbridge_name|x\nbridge_virtual_router|x\nmsg_vpn_name|x\nremote_subscription_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Remote Subscription is a topic subscription used by the Message VPN Bridge to attract messages from the remote message broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions/{remoteSubscriptionTopic}", PostPathTemplate: "/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/remoteSubscriptions", diff --git a/internal/broker/generated/MsgVpnCertMatchingRule.go b/internal/broker/generated/MsgVpnCertMatchingRule.go index 5a63d825..c95311eb 100644 --- a/internal/broker/generated/MsgVpnCertMatchingRule.go +++ b/internal/broker/generated/MsgVpnCertMatchingRule.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_cert_matching_rule", - MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "A Cert Matching Rule is a collection of conditions and attribute filters that all have to be satisfied for certificate to be acceptable as authentication for a given username.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go b/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go index 9ad6a846..863fc9e9 100644 --- a/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go +++ b/internal/broker/generated/MsgVpnCertMatchingRuleAttributeFilter.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_cert_matching_rule_attribute_filter", - MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\nAttribute|Identifying\n:---|:---:\nfilter_name|x\nmsg_vpn_name|x\nrule_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", + MarkdownDescription: "A Cert Matching Rule Attribute Filter compares a username attribute to a string.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.28.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/attributeFilters/{filterName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go b/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go index 7e9fe92e..5cdb81c0 100644 --- a/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go +++ b/internal/broker/generated/MsgVpnCertMatchingRuleCondition.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_cert_matching_rule_condition", - MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nrule_name|x\nsource|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "A Cert Matching Rule Condition compares data extracted from a certificate to a username attribute or an expression.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions/{source}", PostPathTemplate: "/msgVpns/{msgVpnName}/certMatchingRules/{ruleName}/conditions", diff --git a/internal/broker/generated/MsgVpnClientProfile.go b/internal/broker/generated/MsgVpnClientProfile.go index ebba8d57..c8263266 100644 --- a/internal/broker/generated/MsgVpnClientProfile.go +++ b/internal/broker/generated/MsgVpnClientProfile.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_client_profile", - MarkdownDescription: "Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nallow_cut_through_forwarding_enabled||x\napi_queue_management_copy_from_on_create_name||x\napi_topic_endpoint_management_copy_from_on_create_name||x\nclient_profile_name|x|\nmsg_vpn_name|x|\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "Client Profiles are used to assign common configuration properties to clients that have been successfully authorized.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/clientProfiles/{clientProfileName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnClientUsername.go b/internal/broker/generated/MsgVpnClientUsername.go index 2517775b..31773931 100644 --- a/internal/broker/generated/MsgVpnClientUsername.go +++ b/internal/broker/generated/MsgVpnClientUsername.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_client_username", - MarkdownDescription: "A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclient_username|x||\nmsg_vpn_name|x||\npassword||x|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A client is only authorized to connect to a Message VPN that is associated with a Client Username that the client has been assigned.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnClientUsernameAttribute.go b/internal/broker/generated/MsgVpnClientUsernameAttribute.go index 76539ca9..6279cf06 100644 --- a/internal/broker/generated/MsgVpnClientUsernameAttribute.go +++ b/internal/broker/generated/MsgVpnClientUsernameAttribute.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_client_username_attribute", - MarkdownDescription: "A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\nAttribute|Identifying\n:---|:---:\nattribute_name|x\nattribute_value|x\nclient_username|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "A ClientUsername Attribute is a key+value pair that can be used to locate a client username, for example when using client certificate mapping.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes/{attributeName},{attributeValue}", PostPathTemplate: "/msgVpns/{msgVpnName}/clientUsernames/{clientUsername}/attributes", diff --git a/internal/broker/generated/MsgVpnDistributedCache.go b/internal/broker/generated/MsgVpnDistributedCache.go index 8d4938da..96c3a787 100644 --- a/internal/broker/generated/MsgVpnDistributedCache.go +++ b/internal/broker/generated/MsgVpnDistributedCache.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache", - MarkdownDescription: "A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnDistributedCacheCluster.go b/internal/broker/generated/MsgVpnDistributedCacheCluster.go index ba6bc208..767cf9c4 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheCluster.go +++ b/internal/broker/generated/MsgVpnDistributedCacheCluster.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster", - MarkdownDescription: "A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go index d1b1f0ef..af3cd65c 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeCluster.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_global_caching_home_cluster", - MarkdownDescription: "A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nhome_cluster_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Home Cache Cluster is a Cache Cluster that is the \"definitive\" Cache Cluster for a given topic in the context of the Global Caching feature.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}", PostPathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters", diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go index 5ca2ca7f..7a603dca 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterGlobalCachingHomeClusterTopicPrefix.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_global_caching_home_cluster_topic_prefix", - MarkdownDescription: "A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nhome_cluster_name|x\nmsg_vpn_name|x\ntopic_prefix|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Topic Prefix is a prefix for a global topic that is available from the containing Home Cache Cluster.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes/{topicPrefix}", PostPathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/globalCachingHomeClusters/{homeClusterName}/topicPrefixes", @@ -106,7 +106,7 @@ func init() { BaseType: broker.String, SempName: "topicPrefix", TerraformName: "topic_prefix", - MarkdownDescription: "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", + MarkdownDescription: "A topic prefix for global topics available from the remote Home Cache Cluster. A wildcard (/>) is implied at the end of the prefix.", Identifying: true, Required: true, RequiresReplace: true, diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go b/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go index 0e3e7a93..98eff674 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterInstance.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_instance", - MarkdownDescription: "A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\ninstance_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go b/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go index 9259a50d..f2fceee6 100644 --- a/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go +++ b/internal/broker/generated/MsgVpnDistributedCacheClusterTopic.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_distributed_cache_cluster_topic", - MarkdownDescription: "The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\ncluster_name|x\nmsg_vpn_name|x\ntopic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "The Cache Instances that belong to the containing Cache Cluster will cache any messages published to topics that match a Topic Subscription.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics/{topic}", PostPathTemplate: "/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/topics", diff --git a/internal/broker/generated/MsgVpnDmrBridge.go b/internal/broker/generated/MsgVpnDmrBridge.go index adec08ae..c4a2c33a 100644 --- a/internal/broker/generated/MsgVpnDmrBridge.go +++ b/internal/broker/generated/MsgVpnDmrBridge.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_dmr_bridge", - MarkdownDescription: "A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nremote_node_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "A DMR Bridge is required to establish a data channel over a corresponding external link to the remote node for a given Message VPN. Each DMR Bridge identifies which external link the Message VPN should use, and what the name of the equivalent Message VPN at the remote node is.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/dmrBridges/{remoteNodeName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnJndiConnectionFactory.go b/internal/broker/generated/MsgVpnJndiConnectionFactory.go index 9c35d590..f65180bc 100644 --- a/internal/broker/generated/MsgVpnJndiConnectionFactory.go +++ b/internal/broker/generated/MsgVpnJndiConnectionFactory.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_jndi_connection_factory", - MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nconnection_factory_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Connection Factory objects that clients can access through JNDI lookups.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/jndiConnectionFactories/{connectionFactoryName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnJndiQueue.go b/internal/broker/generated/MsgVpnJndiQueue.go index 375c65a1..fe002e26 100644 --- a/internal/broker/generated/MsgVpnJndiQueue.go +++ b/internal/broker/generated/MsgVpnJndiQueue.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_jndi_queue", - MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Queue objects that clients can access through JNDI lookups.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/jndiQueues/{queueName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnJndiTopic.go b/internal/broker/generated/MsgVpnJndiTopic.go index d1738606..8fb738b0 100644 --- a/internal/broker/generated/MsgVpnJndiTopic.go +++ b/internal/broker/generated/MsgVpnJndiTopic.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_jndi_topic", - MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntopic_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", + MarkdownDescription: "The message broker provides an internal JNDI store for provisioned Topic objects that clients can access through JNDI lookups.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.2.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/jndiTopics/{topicName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnKafkaReceiver.go b/internal/broker/generated/MsgVpnKafkaReceiver.go index a323139b..175fdbeb 100644 --- a/internal/broker/generated/MsgVpnKafkaReceiver.go +++ b/internal/broker/generated/MsgVpnKafkaReceiver.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_receiver", - MarkdownDescription: "A Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\nauthentication_client_cert_content||x|x\nauthentication_client_cert_password||x|\nauthentication_oauth_client_secret||x|x\nauthentication_scram_password||x|x\nkafka_receiver_name|x||\nmsg_vpn_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Kafka Receiver receives messages from a Kafka Cluster.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -98,6 +98,75 @@ func init() { }, Default: "", }, + { + 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.", + Sensitive: true, + Requires: []string{"authentication_kerberos_keytab_file_name", "authentication_kerberos_user_principal_name"}, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.AlsoRequires( + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_file_name"), + path.MatchRelative().AtParent().AtName("authentication_kerberos_user_principal_name"), + ), + stringvalidator.LengthBetween(0, 2048), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "authenticationKerberosKeytabFileName", + TerraformName: "authentication_kerberos_keytab_file_name", + MarkdownDescription: "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.", + Requires: []string{"authentication_kerberos_keytab_content", "authentication_kerberos_user_principal_name"}, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.AlsoRequires( + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_content"), + path.MatchRelative().AtParent().AtName("authentication_kerberos_user_principal_name"), + ), + stringvalidator.LengthBetween(0, 255), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "authenticationKerberosServiceName", + TerraformName: "authentication_kerberos_service_name", + MarkdownDescription: "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.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 128), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "authenticationKerberosUserPrincipalName", + TerraformName: "authentication_kerberos_user_principal_name", + MarkdownDescription: "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.", + Requires: []string{"authentication_kerberos_keytab_content", "authentication_kerberos_keytab_file_name"}, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.AlsoRequires( + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_content"), + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_file_name"), + ), + stringvalidator.LengthBetween(0, 642), + stringvalidator.RegexMatches(regexp.MustCompile("^(.+@.+)?$"), ""), + }, + Default: "", + }, { BaseType: broker.String, SempName: "authenticationOauthClientId", @@ -156,12 +225,12 @@ func init() { BaseType: broker.String, SempName: "authenticationScheme", TerraformName: "authentication_scheme", - MarkdownDescription: "The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.\n
\n", + MarkdownDescription: "The authentication scheme for the Kafka Receiver. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.\n\"kerberos\" - Kerberos Authentication.\n\"oauth-client\" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, StringValidators: []validator.String{ - stringvalidator.OneOf("none", "basic", "scram", "client-certificate", "oauth-client"), + stringvalidator.OneOf("none", "basic", "scram", "client-certificate", "kerberos", "oauth-client"), }, Default: "none", }, @@ -245,7 +314,7 @@ func init() { Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, StringValidators: []validator.String{ stringvalidator.LengthBetween(0, 1044), - stringvalidator.RegexMatches(regexp.MustCompile("^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$"), ""), + stringvalidator.RegexMatches(regexp.MustCompile("^(((((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$"), ""), }, Default: "", }, @@ -344,13 +413,12 @@ func init() { BaseType: broker.String, SempName: "metadataTopicExcludeList", TerraformName: "metadata_topic_exclude_list", - MarkdownDescription: "A comma-separated list of regular expressions. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "A comma-separated list of POSIX.2 regular expressions. Commas within each regular expression must be escaped as double commas. Any matching topic names will be ignored in broker metadata. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, StringValidators: []validator.String{ stringvalidator.LengthBetween(0, 1023), - stringvalidator.RegexMatches(regexp.MustCompile("^(((\\^.*|[a-zA-Z0-9\\._\\-]+),)*(\\^.*|[a-zA-Z0-9\\._\\-]+))?$"), ""), }, Default: "", }, diff --git a/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go b/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go index f7c62122..46e42c30 100644 --- a/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go +++ b/internal/broker/generated/MsgVpnKafkaReceiverTopicBinding.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_receiver_topic_binding", - MarkdownDescription: "A Topic Binding receives messages from a remote Kafka Topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafka_receiver_name|x\nmsg_vpn_name|x\ntopic_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Topic Binding receives messages from a remote Kafka Topic.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}/topicBindings/{topicName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -120,7 +120,7 @@ func init() { BaseType: broker.String, SempName: "topicName", TerraformName: "topic_name", - MarkdownDescription: "The name of the Topic.", + MarkdownDescription: "The name of the Topic or a POSIX.2 regular expression starting with '^'.", Identifying: true, Required: true, RequiresReplace: true, @@ -129,7 +129,7 @@ func init() { Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, StringValidators: []validator.String{ stringvalidator.LengthBetween(1, 255), - stringvalidator.RegexMatches(regexp.MustCompile("^\\^.*|[a-zA-Z0-9\\._\\-]+$"), ""), + stringvalidator.RegexMatches(regexp.MustCompile("^\\^.{0,254}|[a-zA-Z0-9\\._\\-]{1,255}$"), ""), }, }, }, diff --git a/internal/broker/generated/MsgVpnKafkaSender.go b/internal/broker/generated/MsgVpnKafkaSender.go index c07291f2..14541af2 100644 --- a/internal/broker/generated/MsgVpnKafkaSender.go +++ b/internal/broker/generated/MsgVpnKafkaSender.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_sender", - MarkdownDescription: "A Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\nauthentication_client_cert_content||x|x\nauthentication_client_cert_password||x|\nauthentication_oauth_client_secret||x|x\nauthentication_scram_password||x|x\nkafka_sender_name|x||\nmsg_vpn_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Kafka Sender sends messages to a Kafka Cluster.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -98,6 +98,75 @@ func init() { }, Default: "", }, + { + 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.", + Sensitive: true, + Requires: []string{"authentication_kerberos_keytab_file_name", "authentication_kerberos_user_principal_name"}, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.AlsoRequires( + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_file_name"), + path.MatchRelative().AtParent().AtName("authentication_kerberos_user_principal_name"), + ), + stringvalidator.LengthBetween(0, 2048), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "authenticationKerberosKeytabFileName", + TerraformName: "authentication_kerberos_keytab_file_name", + MarkdownDescription: "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.", + Requires: []string{"authentication_kerberos_keytab_content", "authentication_kerberos_user_principal_name"}, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.AlsoRequires( + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_content"), + path.MatchRelative().AtParent().AtName("authentication_kerberos_user_principal_name"), + ), + stringvalidator.LengthBetween(0, 255), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "authenticationKerberosServiceName", + TerraformName: "authentication_kerberos_service_name", + MarkdownDescription: "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.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 128), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "authenticationKerberosUserPrincipalName", + TerraformName: "authentication_kerberos_user_principal_name", + MarkdownDescription: "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.", + Requires: []string{"authentication_kerberos_keytab_content", "authentication_kerberos_keytab_file_name"}, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.AlsoRequires( + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_content"), + path.MatchRelative().AtParent().AtName("authentication_kerberos_keytab_file_name"), + ), + stringvalidator.LengthBetween(0, 642), + stringvalidator.RegexMatches(regexp.MustCompile("^(.+@.+)?$"), ""), + }, + Default: "", + }, { BaseType: broker.String, SempName: "authenticationOauthClientId", @@ -156,12 +225,12 @@ func init() { BaseType: broker.String, SempName: "authenticationScheme", TerraformName: "authentication_scheme", - MarkdownDescription: "The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.\n\"oauth-client\" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.\n
\n", + MarkdownDescription: "The authentication scheme for the Kafka Sender. The bootstrap addresses must resolve to an appropriately configured and compatible listener port on the Kafka broker for the given scheme. Modifying this attribute while the object (or the relevant part of the object) is administratively enabled may be service impacting as enabled will be temporarily set to false to apply the change. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"none\"`. The allowed values and their meaning are:\n\n
\n\"none\" - Anonymous Authentication. Used with Kafka broker PLAINTEXT listener ports.\n\"basic\" - Basic Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"scram\" - Salted Challenge Response Authentication. Used with Kafka broker SASL_PLAINTEXT and SASL_SSL listener ports.\n\"client-certificate\" - Client Certificate Authentication. Used with Kafka broker SSL listener ports.\n\"kerberos\" - Kerberos Authentication.\n\"oauth-client\" - Oauth Authentication. Used with Kafka broker SASL_SSL listener ports.\n
\n", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, StringValidators: []validator.String{ - stringvalidator.OneOf("none", "basic", "scram", "client-certificate", "oauth-client"), + stringvalidator.OneOf("none", "basic", "scram", "client-certificate", "kerberos", "oauth-client"), }, Default: "none", }, @@ -258,7 +327,7 @@ func init() { Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, StringValidators: []validator.String{ stringvalidator.LengthBetween(0, 1044), - stringvalidator.RegexMatches(regexp.MustCompile("^(((((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.])+)|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$"), ""), + stringvalidator.RegexMatches(regexp.MustCompile("^(((((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})),)*(((([0-9a-zA-Z\\-\\.]){1,253})|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])((:[0-9]{1,5}){0,1})))?$"), ""), }, Default: "", }, diff --git a/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go b/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go index 12c14590..a7535ae5 100644 --- a/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go +++ b/internal/broker/generated/MsgVpnKafkaSenderQueueBinding.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_kafka_sender_queue_binding", - MarkdownDescription: "A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\nAttribute|Identifying\n:---|:---:\nkafka_sender_name|x\nmsg_vpn_name|x\nqueue_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "A Queue Binding sends messages from a local Solace Queue to a remote Kafka topic.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}/queueBindings/{queueName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnMqttRetainCache.go b/internal/broker/generated/MsgVpnMqttRetainCache.go index 3a73ff78..5b9a654d 100644 --- a/internal/broker/generated/MsgVpnMqttRetainCache.go +++ b/internal/broker/generated/MsgVpnMqttRetainCache.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_mqtt_retain_cache", - MarkdownDescription: "Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\nAttribute|Identifying\n:---|:---:\ncache_name|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", + MarkdownDescription: "Using MQTT retained messages allows publishing MQTT clients to indicate that a message must be stored for later delivery to subscribing clients when those subscribing clients add subscriptions matching the retained message's topic. An MQTT Retain Cache processes all retained messages for a Message VPN.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.11.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/mqttRetainCaches/{cacheName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnMqttSession.go b/internal/broker/generated/MsgVpnMqttSession.go index 47910b4d..0c0ee935 100644 --- a/internal/broker/generated/MsgVpnMqttSession.go +++ b/internal/broker/generated/MsgVpnMqttSession.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_mqtt_session", - MarkdownDescription: "An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqtt_session_client_id|x\nmqtt_session_virtual_router|x\nmsg_vpn_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "An MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnMqttSessionSubscription.go b/internal/broker/generated/MsgVpnMqttSessionSubscription.go index 6d7633e4..d5ea972e 100644 --- a/internal/broker/generated/MsgVpnMqttSessionSubscription.go +++ b/internal/broker/generated/MsgVpnMqttSessionSubscription.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_mqtt_session_subscription", - MarkdownDescription: "An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\nAttribute|Identifying\n:---|:---:\nmqtt_session_client_id|x\nmqtt_session_virtual_router|x\nmsg_vpn_name|x\nsubscription_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "An MQTT session contains a client's QoS 0 and QoS 1 subscription sets. On creation, a subscription defaults to QoS 0.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/subscriptions/{subscriptionTopic}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnProxy.go b/internal/broker/generated/MsgVpnProxy.go index fd6e56de..5e2bc9d4 100644 --- a/internal/broker/generated/MsgVpnProxy.go +++ b/internal/broker/generated/MsgVpnProxy.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_proxy", - MarkdownDescription: "Proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_basic_password||x|x\nmsg_vpn_name|x||\nproxy_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", + MarkdownDescription: "proxy objects define the connection parameters for a proxy server. To use a proxy for a particular connection such as a REST Consumer, select the proxy by name in the configuration for that object.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.36.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/proxies/{proxyName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -78,7 +78,7 @@ func init() { BaseType: broker.Bool, SempName: "enabled", TerraformName: "enabled", - MarkdownDescription: "Enable or disable the proxy. When disabled, no connections are initiated to this particular Proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + MarkdownDescription: "Enable or disable the proxy. When disabled, no connections are initiated to this particular proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", Type: types.BoolType, TerraformType: tftypes.Bool, Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, diff --git a/internal/broker/generated/MsgVpnQueue.go b/internal/broker/generated/MsgVpnQueue.go index fde57edd..29ade807 100644 --- a/internal/broker/generated/MsgVpnQueue.go +++ b/internal/broker/generated/MsgVpnQueue.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_queue", - MarkdownDescription: "A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/queues/{queueName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnQueueSubscription.go b/internal/broker/generated/MsgVpnQueueSubscription.go index 1436a5cd..02e3bab2 100644 --- a/internal/broker/generated/MsgVpnQueueSubscription.go +++ b/internal/broker/generated/MsgVpnQueueSubscription.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_queue_subscription", - MarkdownDescription: "One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_name|x\nsubscription_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "One or more Queue Subscriptions can be added to a durable queue so that Guaranteed messages published to matching topics are also delivered to and spooled by the queue.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions/{subscriptionTopic}", PostPathTemplate: "/msgVpns/{msgVpnName}/queues/{queueName}/subscriptions", diff --git a/internal/broker/generated/MsgVpnQueueTemplate.go b/internal/broker/generated/MsgVpnQueueTemplate.go index c131d41f..2dcefc92 100644 --- a/internal/broker/generated/MsgVpnQueueTemplate.go +++ b/internal/broker/generated/MsgVpnQueueTemplate.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_queue_template", - MarkdownDescription: "A Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_template_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Queue Template provides a mechanism for specifying the initial state for client created queues.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/queueTemplates/{queueTemplateName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -492,7 +492,7 @@ func init() { BaseType: broker.String, SempName: "queueNameFilter", TerraformName: "queue_name_filter", - MarkdownDescription: "A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "A pattern used to determine which Queues use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", Type: types.StringType, TerraformType: tftypes.String, Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, diff --git a/internal/broker/generated/MsgVpnReplayLog.go b/internal/broker/generated/MsgVpnReplayLog.go index becf78e7..e2abf548 100644 --- a/internal/broker/generated/MsgVpnReplayLog.go +++ b/internal/broker/generated/MsgVpnReplayLog.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_replay_log", - MarkdownDescription: "When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreplay_log_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.10.", + MarkdownDescription: "When the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.10.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go b/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go index c03fa4e1..fc1ee3d9 100644 --- a/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go +++ b/internal/broker/generated/MsgVpnReplayLogTopicFilterSubscription.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_replay_log_topic_filter_subscription", - MarkdownDescription: "One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreplay_log_name|x\ntopic_filter_subscription|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", + MarkdownDescription: "One or more Subscriptions can be added to a replay-log so that only guaranteed messages published to matching topics are stored in the Replay Log.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.27.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions/{topicFilterSubscription}", PostPathTemplate: "/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/topicFilterSubscriptions", diff --git a/internal/broker/generated/MsgVpnReplicatedTopic.go b/internal/broker/generated/MsgVpnReplicatedTopic.go index 899b36b2..dacb3cb1 100644 --- a/internal/broker/generated/MsgVpnReplicatedTopic.go +++ b/internal/broker/generated/MsgVpnReplicatedTopic.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_replicated_topic", - MarkdownDescription: "To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreplicated_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "To indicate which messages should be replicated between the active and standby site, a Replicated Topic subscription must be configured on a Message VPN. If a published message matches both a replicated topic and an endpoint on the active site, then the message is replicated to the standby site.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/replicatedTopics/{replicatedTopic}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnRestDeliveryPoint.go b/internal/broker/generated/MsgVpnRestDeliveryPoint.go index 8269ce58..a89d0f7d 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPoint.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPoint.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point", - MarkdownDescription: "A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go index 10c195b8..f016b319 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBinding.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_queue_binding", - MarkdownDescription: "A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nqueue_binding_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "A Queue Binding for a REST Delivery Point attracts messages to be delivered to REST consumers. If the queue does not exist it can be created subsequently, and once the queue is operational the broker performs the queue binding. Removing the queue binding does not delete the queue itself. Similarly, removing the queue does not remove the queue binding, which fails until the queue is recreated or the queue binding is deleted.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go index 65708945..714a81b2 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingProtectedRequestHeader.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_queue_binding_protected_request_header", - MarkdownDescription: "A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nheader_name|x||\nheader_value||x|x\nmsg_vpn_name|x||\nqueue_binding_name|x||\nrest_delivery_point_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.30.", + MarkdownDescription: "A protected request header to be added to the HTTP request. Unlike a non-protected request header, the header value cannot be displayed after it is set.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.30.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/protectedRequestHeaders/{headerName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go index e38957a7..32215d16 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointQueueBindingRequestHeader.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_queue_binding_request_header", - MarkdownDescription: "A request header to be added to the HTTP request.\n\n\nAttribute|Identifying\n:---|:---:\nheader_name|x\nmsg_vpn_name|x\nqueue_binding_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.23.", + MarkdownDescription: "A request header to be added to the HTTP request.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.23.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/queueBindings/{queueBindingName}/requestHeaders/{headerName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go index 1320c97c..36273a31 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumer.go @@ -31,7 +31,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_rest_consumer", - MarkdownDescription: "REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nauthentication_aws_secret_access_key||x|x\nauthentication_client_cert_content||x|x\nauthentication_client_cert_password||x|\nauthentication_http_basic_password||x|x\nauthentication_http_header_value||x|x\nauthentication_oauth_client_secret||x|x\nauthentication_oauth_jwt_secret_key||x|x\nmsg_vpn_name|x||\nrest_consumer_name|x||\nrest_delivery_point_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + MarkdownDescription: "REST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go index 6ecc678e..8b64a1e2 100644 --- a/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go +++ b/internal/broker/generated/MsgVpnRestDeliveryPointRestConsumerOauthJwtClaim.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_rest_delivery_point_rest_consumer_oauth_jwt_claim", - MarkdownDescription: "A Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\noauth_jwt_claim_name|x\nrest_consumer_name|x\nrest_delivery_point_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.21.", + MarkdownDescription: "A Claim is added to the JWT sent to the OAuth token request endpoint.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.21.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims/{oauthJwtClaimName}", PostPathTemplate: "/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/oauthJwtClaims", diff --git a/internal/broker/generated/MsgVpnSequencedTopic.go b/internal/broker/generated/MsgVpnSequencedTopic.go index 4c067b77..596da20b 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\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nsequenced_topic|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.0.", + 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.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/sequencedTopics/{sequencedTopic}", PostPathTemplate: "/msgVpns/{msgVpnName}/sequencedTopics", diff --git a/internal/broker/generated/MsgVpnTelemetryProfile.go b/internal/broker/generated/MsgVpnTelemetryProfile.go index d40afe68..f27e961f 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfile.go +++ b/internal/broker/generated/MsgVpnTelemetryProfile.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile", - MarkdownDescription: "Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntelemetry_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "Using the Telemetry Profile allows trace spans to be generated as messages are processed by the broker. The generated spans are stored persistently on the broker and may be consumed by the Solace receiver component of an OpenTelemetry Collector.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go b/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go index 986c3e64..5ac8acea 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go +++ b/internal/broker/generated/MsgVpnTelemetryProfileReceiverAclConnectException.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile_receiver_acl_connect_exception", - MarkdownDescription: "A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nreceiver_acl_connect_exception_address|x\ntelemetry_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "A Receiver ACL Connect Exception is an exception to the default action to take when a receiver connects to the broker. Exceptions must be expressed as an IP address/netmask in CIDR form.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/receiverAclConnectExceptions/{receiverAclConnectExceptionAddress}", PostPathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/receiverAclConnectExceptions", diff --git a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go index 873defc5..e0e9314c 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go +++ b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilter.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile_trace_filter", - MarkdownDescription: "A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntelemetry_profile_name|x\ntrace_filter_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "A Trace Filter controls which messages received by the broker will be traced. If an incoming message matches an enabled tracing filter's subscription, the message will be traced as it passes through the broker.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go index c10b1b3f..b63b5ac0 100644 --- a/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go +++ b/internal/broker/generated/MsgVpnTelemetryProfileTraceFilterSubscription.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_telemetry_profile_trace_filter_subscription", - MarkdownDescription: "Trace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\nsubscription|x\nsubscription_syntax|x\ntelemetry_profile_name|x\ntrace_filter_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", + MarkdownDescription: "Trace filter subscriptions control which messages will be attracted by the tracing filter.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.31.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}/subscriptions/{subscription},{subscriptionSyntax}", PostPathTemplate: "/msgVpns/{msgVpnName}/telemetryProfiles/{telemetryProfileName}/traceFilters/{traceFilterName}/subscriptions", diff --git a/internal/broker/generated/MsgVpnTopicEndpoint.go b/internal/broker/generated/MsgVpnTopicEndpoint.go index 52151c02..e7b96671 100644 --- a/internal/broker/generated/MsgVpnTopicEndpoint.go +++ b/internal/broker/generated/MsgVpnTopicEndpoint.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_topic_endpoint", - MarkdownDescription: "A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntopic_endpoint_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", + MarkdownDescription: "A Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.1.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/MsgVpnTopicEndpointTemplate.go b/internal/broker/generated/MsgVpnTopicEndpointTemplate.go index a2abfe3f..818598f7 100644 --- a/internal/broker/generated/MsgVpnTopicEndpointTemplate.go +++ b/internal/broker/generated/MsgVpnTopicEndpointTemplate.go @@ -30,7 +30,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "msg_vpn_topic_endpoint_template", - MarkdownDescription: "A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\ntopic_endpoint_template_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", + MarkdownDescription: "A Topic Endpoint Template provides a mechanism for specifying the initial state for client created topic endpoints.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"vpn/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.14.", ObjectType: broker.StandardObject, PathTemplate: "/msgVpns/{msgVpnName}/topicEndpointTemplates/{topicEndpointTemplateName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -594,7 +594,7 @@ func init() { BaseType: broker.String, SempName: "topicEndpointNameFilter", TerraformName: "topic_endpoint_name_filter", - MarkdownDescription: "A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", + MarkdownDescription: "A pattern used to determine which Topic Endpoints use settings from this Template. Two different wildcards can be used in the pattern: * and >. Similar to topic filters or subscription patterns, a > matches anything (but only when used at the end), and a * matches zero or more characters but never a slash (/). A > is only a wildcard when used at the end, after a /. A * is only allowed at the end, after a slash (/). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.", 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 e537fd46..94c08983 100644 --- a/internal/broker/generated/OauthProfile.go +++ b/internal/broker/generated/OauthProfile.go @@ -29,7 +29,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile", - MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying|Write-Only|Opaque\n:---|:---:|:---:|:---:\nclient_secret||x|x\noauth_profile_name|x||\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "OAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}", Version: 0, // Placeholder: value will be replaced in the provider code @@ -406,6 +406,19 @@ func init() { }, Default: "client", }, + { + BaseType: broker.String, + SempName: "proxyName", + TerraformName: "proxy_name", + MarkdownDescription: "The name of the proxy to use for discovery, user info, jwks, and introspection requests. Leave empty for no proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since SEMP API version 2.41.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 32), + }, + Default: "", + }, { BaseType: broker.Bool, SempName: "resourceServerParseAccessTokenEnabled", diff --git a/internal/broker/generated/OauthProfileAccessLevelGroup.go b/internal/broker/generated/OauthProfileAccessLevelGroup.go index 9b1b1acf..c7cf0d83 100644 --- a/internal/broker/generated/OauthProfileAccessLevelGroup.go +++ b/internal/broker/generated/OauthProfileAccessLevelGroup.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_access_level_group", - MarkdownDescription: "The name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\nAttribute|Identifying\n:---|:---:\ngroup_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "The name of a group as it exists on the OAuth server being used to authenticate SEMP users.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go b/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go index c90a64f1..508fa41e 100644 --- a/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go +++ b/internal/broker/generated/OauthProfileAccessLevelGroupMsgVpnAccessLevelException.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_access_level_group_msg_vpn_access_level_exception", - MarkdownDescription: "Message VPN access-level exceptions for members of this group.\n\n\nAttribute|Identifying\n:---|:---:\ngroup_name|x\nmsg_vpn_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Message VPN access-level exceptions for members of this group.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/accessLevelGroups/{groupName}/msgVpnAccessLevelExceptions/{msgVpnName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/OauthProfileClientAllowedHost.go b/internal/broker/generated/OauthProfileClientAllowedHost.go index 1f4837b7..f2a8bf12 100644 --- a/internal/broker/generated/OauthProfileClientAllowedHost.go +++ b/internal/broker/generated/OauthProfileClientAllowedHost.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_client_allowed_host", - MarkdownDescription: "A valid hostname for this broker in OAuth redirects.\n\n\nAttribute|Identifying\n:---|:---:\nallowed_host|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "A valid hostname for this broker in OAuth redirects.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/clientAllowedHosts/{allowedHost}", PostPathTemplate: "/oauthProfiles/{oauthProfileName}/clientAllowedHosts", diff --git a/internal/broker/generated/OauthProfileClientAuthorizationParameter.go b/internal/broker/generated/OauthProfileClientAuthorizationParameter.go index ed966af3..e979967e 100644 --- a/internal/broker/generated/OauthProfileClientAuthorizationParameter.go +++ b/internal/broker/generated/OauthProfileClientAuthorizationParameter.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_client_authorization_parameter", - MarkdownDescription: "Additional parameters to be passed to the OAuth authorization endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nauthorization_parameter_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Additional parameters to be passed to the OAuth authorization endpoint.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/clientAuthorizationParameters/{authorizationParameterName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/OauthProfileClientRequiredClaim.go b/internal/broker/generated/OauthProfileClientRequiredClaim.go index 5443b37c..7b346ba0 100644 --- a/internal/broker/generated/OauthProfileClientRequiredClaim.go +++ b/internal/broker/generated/OauthProfileClientRequiredClaim.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_client_required_claim", - MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\nAttribute|Identifying\n:---|:---:\nclient_required_claim_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Additional claims to be verified in the ID token.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/clientRequiredClaims/{clientRequiredClaimName}", PostPathTemplate: "/oauthProfiles/{oauthProfileName}/clientRequiredClaims", diff --git a/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go b/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go index 3dae0a9f..a92ec8bf 100644 --- a/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go +++ b/internal/broker/generated/OauthProfileDefaultMsgVpnAccessLevelException.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_default_msg_vpn_access_level_exception", - MarkdownDescription: "Default message VPN access-level exceptions.\n\n\nAttribute|Identifying\n:---|:---:\nmsg_vpn_name|x\noauth_profile_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Default message VPN access-level exceptions.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.StandardObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/defaultMsgVpnAccessLevelExceptions/{msgVpnName}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go b/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go index 0d22964f..375a5044 100644 --- a/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go +++ b/internal/broker/generated/OauthProfileResourceServerRequiredClaim.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "oauth_profile_resource_server_required_claim", - MarkdownDescription: "Additional claims to be verified in the access token.\n\n\nAttribute|Identifying\n:---|:---:\noauth_profile_name|x\nresource_server_required_claim_name|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", + MarkdownDescription: "Additional claims to be verified in the access token.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.24.", ObjectType: broker.ReplaceOnlyObject, PathTemplate: "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims/{resourceServerRequiredClaimName}", PostPathTemplate: "/oauthProfiles/{oauthProfileName}/resourceServerRequiredClaims", diff --git a/internal/broker/generated/Proxy.go b/internal/broker/generated/Proxy.go new file mode 100644 index 00000000..588b2061 --- /dev/null +++ b/internal/broker/generated/Proxy.go @@ -0,0 +1,147 @@ +// terraform-provider-solacebroker +// +// Copyright 2024 Solace Corporation. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package generated + +import ( + "github.com/hashicorp/terraform-plugin-framework-validators/int64validator" + "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator" + "github.com/hashicorp/terraform-plugin-framework/schema/validator" + "github.com/hashicorp/terraform-plugin-framework/types" + "github.com/hashicorp/terraform-plugin-go/tftypes" + "regexp" + "terraform-provider-solacebroker/internal/broker" +) + +func init() { + info := broker.EntityInputs{ + TerraformName: "proxy", + MarkdownDescription: "proxy 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\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.41.", + ObjectType: broker.StandardObject, + PathTemplate: "/proxies/{proxyName}", + Version: 0, // Placeholder: value will be replaced in the provider code + Attributes: []*broker.AttributeInfo{ + { + 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 `\"\"`.", + Sensitive: true, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 64), + }, + Default: "", + }, + { + BaseType: broker.String, + SempName: "authenticationBasicUsername", + TerraformName: "authentication_basic_username", + MarkdownDescription: "The username to use with basic authentication. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + 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: "authenticationScheme", + TerraformName: "authentication_scheme", + MarkdownDescription: "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:\n\n
\n\"none\" - No authentication.\n\"basic\" - Username/password authentication.\n
\n", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.OneOf("none", "basic"), + }, + Default: "none", + }, + { + BaseType: broker.Bool, + SempName: "enabled", + TerraformName: "enabled", + MarkdownDescription: "Enable or disable the proxy. When disabled, no connections are initiated to this particular proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.", + Type: types.BoolType, + TerraformType: tftypes.Bool, + Converter: broker.SimpleConverter[bool]{TerraformType: tftypes.Bool}, + Default: false, + }, + { + BaseType: broker.String, + SempName: "host", + TerraformName: "host", + MarkdownDescription: "The IP address or host name of the proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(0, 253), + stringvalidator.RegexMatches(regexp.MustCompile("^([0-9a-zA-Z\\-\\.]*|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,7}:|\\[([0-9a-fA-F]{1,4}:){1,7}:\\]|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|\\[([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\\]|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|\\[([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}\\]|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|\\[([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}\\]|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|\\[([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}\\]|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|\\[([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}\\]|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|\\[[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})\\]|:((:[0-9a-fA-F]{1,4}){1,7}|:)|\\[:((:[0-9a-fA-F]{1,4}){1,7}|:)\\])$"), ""), + }, + Default: "", + }, + { + BaseType: broker.Int64, + SempName: "port", + TerraformName: "port", + MarkdownDescription: "The port to connect to on the proxy host. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`.", + Type: types.Int64Type, + TerraformType: tftypes.Number, + Converter: broker.IntegerConverter{}, + Int64Validators: []validator.Int64{ + int64validator.Between(0, 65535), + }, + Default: 0, + }, + { + BaseType: broker.String, + SempName: "proxyName", + TerraformName: "proxy_name", + MarkdownDescription: "The name of the proxy.", + Identifying: true, + Required: true, + RequiresReplace: true, + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.LengthBetween(1, 32), + stringvalidator.RegexMatches(regexp.MustCompile("^[^#*? ]([^*?]*[^*? ])?$"), ""), + }, + }, + { + BaseType: broker.String, + SempName: "proxyType", + TerraformName: "proxy_type", + MarkdownDescription: "The type of proxy. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"direct\"`. The allowed values and their meaning are:\n\n
\n\"direct\" - Direct connection (no proxy).\n\"http\" - HTTP proxy.\n
\n", + Type: types.StringType, + TerraformType: tftypes.String, + Converter: broker.SimpleConverter[string]{TerraformType: tftypes.String}, + StringValidators: []validator.String{ + stringvalidator.OneOf("direct", "http"), + }, + Default: "direct", + }, + }, + } + broker.RegisterResource(info) + broker.RegisterDataSource(info) +} diff --git a/internal/broker/generated/VersionDetails.go b/internal/broker/generated/VersionDetails.go index b3953b7b..01196d99 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.39" +const SempVersion = "2.41" const Platform = "VMR" func init() { diff --git a/internal/broker/generated/VirtualHostname.go b/internal/broker/generated/VirtualHostname.go index c91507bd..ec87fceb 100644 --- a/internal/broker/generated/VirtualHostname.go +++ b/internal/broker/generated/VirtualHostname.go @@ -28,7 +28,7 @@ import ( func init() { info := broker.EntityInputs{ TerraformName: "virtual_hostname", - MarkdownDescription: "A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\nAttribute|Identifying\n:---|:---:\nvirtual_hostname|x\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.17.", + MarkdownDescription: "A Virtual Hostname is a provisioned object on a message broker that contains a Virtual Hostname to Message VPN mapping.\n\nClients which connect to a global (as opposed to per Message VPN) port and provides this hostname will be directed to its corresponding Message VPN. A case-insentive match is performed on the full client-provided hostname against the configured virtual-hostname.\n\nThis mechanism is only supported for hostnames provided through the Server Name Indication (SNI) extension of TLS.\n\n\n\nA SEMP client authorized with a minimum access scope/level of \"global/read-only\" is required to perform this operation.\n\nThis has been available since SEMP API version 2.17.", ObjectType: broker.StandardObject, PathTemplate: "/virtualHostnames/{virtualHostname}", Version: 0, // Placeholder: value will be replaced in the provider code diff --git a/internal/broker/schema.go b/internal/broker/schema.go index d95dfafe..57239a39 100644 --- a/internal/broker/schema.go +++ b/internal/broker/schema.go @@ -87,6 +87,10 @@ func terraformAttributeMap(attributes []*AttributeInfo, isResource bool, require continue } attrRequiresReplace := isResource && (requiresReplace || attr.RequiresReplace) + markdownDescription := attr.MarkdownDescription + if attrRequiresReplace && !attr.Identifying { + markdownDescription += " Note that this attribute requires replacement of the resource when updated." + } if len(attr.Attributes) != 0 { childTypes := map[string]tftypes.Type{} for _, cAttr := range attr.Attributes { @@ -104,7 +108,7 @@ func terraformAttributeMap(attributes []*AttributeInfo, isResource bool, require case String: tfAttributes[attr.TerraformName] = schema.StringAttribute{ Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, + MarkdownDescription: markdownDescription, Required: attr.Required && isResource || !isResource && attr.Identifying, Optional: !attr.Required && isResource, Computed: !attr.Identifying && !isResource, @@ -116,7 +120,7 @@ func terraformAttributeMap(attributes []*AttributeInfo, isResource bool, require case Int64: tfAttributes[attr.TerraformName] = schema.Int64Attribute{ Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, + MarkdownDescription: markdownDescription, Required: attr.Required && isResource || !isResource && attr.Identifying, Optional: !attr.Required && isResource, Computed: !attr.Identifying && !isResource, @@ -128,7 +132,7 @@ func terraformAttributeMap(attributes []*AttributeInfo, isResource bool, require case Bool: tfAttributes[attr.TerraformName] = schema.BoolAttribute{ Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, + MarkdownDescription: markdownDescription, Required: attr.Required && isResource || !isResource && attr.Identifying, Optional: !attr.Required && isResource, Computed: !attr.Identifying && !isResource, @@ -141,7 +145,7 @@ func terraformAttributeMap(attributes []*AttributeInfo, isResource bool, require tfAttributes[attr.TerraformName] = schema.SingleNestedAttribute{ Attributes: terraformAttributeMap(attr.Attributes, isResource, requiresReplace || attr.RequiresReplace), Description: attr.Description, - MarkdownDescription: attr.MarkdownDescription, + MarkdownDescription: markdownDescription, Required: attr.Required && isResource || !isResource && attr.Identifying, Optional: !attr.Required && isResource, Computed: !attr.Identifying && !isResource, @@ -170,9 +174,11 @@ func newBrokerEntity(inputs EntityInputs, isResource bool) brokerEntity[schema.S addObjectConverters(inputs.Attributes) tfAttributes := terraformAttributeMap(inputs.Attributes, isResource, inputs.ObjectType == ReplaceOnlyObject) var identifyingAttributes []*AttributeInfo + identifyingAttributesMap := map[string]string{} for _, attr := range inputs.Attributes { if attr.Identifying { identifyingAttributes = append(identifyingAttributes, attr) + identifyingAttributesMap["{"+attr.SempName+"}"] = "{" + attr.TerraformName + "}" } } sort.Slice(identifyingAttributes, func(i, j int) bool { @@ -182,7 +188,11 @@ func newBrokerEntity(inputs EntityInputs, isResource bool) brokerEntity[schema.S jIndex := strings.Index(inputs.PathTemplate, "{"+jAttr.SempName+"}") return iIndex < jIndex }) - + unsupportedResourceWarning := "" + // Add unsupported warning for any resource not contained within a message vpn + if !strings.HasPrefix(inputs.TerraformName, "msg_vpn") { + unsupportedResourceWarning = "> This resource is not supported in production by Solace in this version, see [provider limitations](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#limitations).\n\n" + } identifierInfo := "" if isResource { identifiersString := "" @@ -193,8 +203,11 @@ func newBrokerEntity(inputs EntityInputs, isResource bool) brokerEntity[schema.S // Construct identifiers string from matches, separated by / identifiers := make([]string, len(matches)) for i, match := range matches { - identifiers[i] = match[0] - // TODO: convert to Terraform Names! + tfIdentifier, ok := identifyingAttributesMap[match[0]] + if !ok { + panic(fmt.Sprintf("No terraform identifier found for %s", match[0])) + } + identifiers[i] = tfIdentifier } identifiersString = fmt.Sprintf("`%s`, where {<attribute>} represents the value of the attribute and it must be URL-encoded.", strings.Join(identifiers, "/")) } else { @@ -206,7 +219,7 @@ func newBrokerEntity(inputs EntityInputs, isResource bool) brokerEntity[schema.S s := schema.Schema{ Attributes: tfAttributes, Description: inputs.Description, - MarkdownDescription: inputs.MarkdownDescription + identifierInfo, + MarkdownDescription: unsupportedResourceWarning + inputs.MarkdownDescription + identifierInfo, DeprecationMessage: inputs.DeprecationMessage, Version: inputs.Version, // This will be replaced by the major version from ProviderVersion in resource.go } diff --git a/internal/broker/utilities.go b/internal/broker/utilities.go index 30c56f94..bc4c83bc 100644 --- a/internal/broker/utilities.go +++ b/internal/broker/utilities.go @@ -135,18 +135,44 @@ func durationWithDefaultFromEnv(value types.String, name string, def time.Durati } func client(providerData *providerData) (*semp.Client, diag.Diagnostic) { - // username, password, bearer token and url will be set to "" if not provided through env or config - username, err := stringWithDefaultFromEnv(providerData.Username, "username") - if err != nil { - return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) - } - password, err := stringWithDefaultFromEnv(providerData.Password, "password") - if err != nil { - return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) - } - bearerToken, err := stringWithDefaultFromEnv(providerData.BearerToken, "bearer_token") - if err != nil { - return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) + // Check for params credentials conflicts + // Logic: + // If there is any 1 complete set of credentials in the provider block those are always used and are the priority. + // If there is not any 1 complete set of credentials in the provider block then look for 1 complete set in the env vars. + // If there are multiple complete sets in either the provider block or env vars this is an error. + // If there are no complete sets in the env vars this is an error. + var username, password, bearerToken string + if !providerData.BearerToken.IsNull() && providerData.Username.IsNull() && providerData.Password.IsNull() || + providerData.BearerToken.IsNull() && !providerData.Username.IsNull() && !providerData.Password.IsNull() { + // these are valid combinations in the provider block, no need to check further + username = providerData.Username.ValueString() + password = providerData.Password.ValueString() + bearerToken = providerData.BearerToken.ValueString() + } else { + // username, password and bearer token will be set to "" if not provided through env or config + username, err := stringWithDefaultFromEnv(providerData.Username, "username") + if err != nil { + return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) + } + password, err := stringWithDefaultFromEnv(providerData.Password, "password") + if err != nil { + return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) + } + bearerToken, err := stringWithDefaultFromEnv(providerData.BearerToken, "bearer_token") + if err != nil { + return nil, diag.NewErrorDiagnostic("Unable to parse provider attribute", err.Error()) + } + if username == "" && password == "" && bearerToken == "" { + return nil, diag.NewErrorDiagnostic("Bearer token or basic authentication credentials must be provided", semp.ErrProviderParametersError.Error()) + } + if (!providerData.BearerToken.IsNull() && (!providerData.Username.IsNull() || !providerData.Password.IsNull())) || + (bearerToken != "" && (username != "" || password != "")) { + return nil, diag.NewErrorDiagnostic("Cannot use Bearer token with basic authentication credentials", semp.ErrProviderParametersError.Error()) + } + if !providerData.Username.IsNull() && providerData.Password.IsNull() || providerData.Username.IsNull() && !providerData.Password.IsNull() || + username != "" && password == "" || username == "" && password != "" { + return nil, diag.NewErrorDiagnostic("Both username and password must be provided for basic authentication and cannot mix params and env vars", semp.ErrProviderParametersError.Error()) + } } url, err := stringWithDefaultFromEnv(providerData.Url, "url") if err != nil { @@ -187,7 +213,7 @@ func client(providerData *providerData) (*semp.Client, diag.Diagnostic) { true, // this is a client for the provider semp.BasicAuth(username, password), semp.BearerToken(bearerToken), - semp.Retries(uint(retries), retryMinInterval, retryMaxInterval), + semp.Retries(retries, retryMinInterval, retryMaxInterval), semp.RequestLimits(requestTimeoutDuration, requestMinInterval)) return client, nil } diff --git a/internal/broker/utilities_test.go b/internal/broker/utilities_test.go new file mode 100644 index 00000000..3ca8659b --- /dev/null +++ b/internal/broker/utilities_test.go @@ -0,0 +1,85 @@ +package broker + +import ( + "os" + "testing" + + "github.com/hashicorp/terraform-plugin-framework/types" +) + +func TestClient(t *testing.T) { + matrix := []struct { + ParamUsername string + ParamPassword string + ParamBearertoken string + EnvUsername string + EnvPassword string + EnvBearertoken string + Expected string + }{ + {"testuser", "testpassword", "testbearertoken", "", "", "", "Cannot use Bearer token with basic authentication credentials"}, + {"", "testpassword", "testbearertoken", "", "", "", "Cannot use Bearer token with basic authentication credentials"}, + {"testuser", "", "testbearertoken", "", "", "", "Cannot use Bearer token with basic authentication credentials"}, + {"", "", "", "testuser", "testpassword", "testbearertoken", "Cannot use Bearer token with basic authentication credentials"}, + {"", "", "", "testuser", "", "testbearertoken", "Cannot use Bearer token with basic authentication credentials"}, + {"", "", "", "", "testpassword", "testbearertoken", "Cannot use Bearer token with basic authentication credentials"}, + {"", "", "", "", "", "", "Bearer token or basic authentication credentials must be provided"}, + {"testuser", "testpassword", "", "", "", "", ""}, + {"", "", "testbearertoken", "", "", "", ""}, + {"", "", "testbearertoken", "", "", "testbearertoken", ""}, + {"testuser", "testpassword", "", "", "", "testbearertoken", ""}, + {"testuser", "testpassword", "", "testuser", "testpassword", "testbearertoken", ""}, + {"", "", "testbearertoken", "testuser", "testpassword", "", ""}, + {"", "", "testbearertoken", "testuser", "testpassword", "testbearertoken", ""}, + {"", "", "", "", "", "testbearertoken", ""}, + {"", "", "", "testuser", "testpassword", "", ""}, + {"testuser", "", "", "", "", "", "Both username and password must be provided for basic authentication and cannot mix params and env vars"}, + {"", "testpassword", "", "", "", "", "Both username and password must be provided for basic authentication and cannot mix params and env vars"}, + {"testuser", "", "", "", "testpassword", "", "Both username and password must be provided for basic authentication and cannot mix params and env vars"}, + {"", "testpassword", "", "testuser", "", "", "Both username and password must be provided for basic authentication and cannot mix params and env vars"}, + } + + // Iterate over the test matrix + for testNr, test := range matrix { + // Set the environment variables + os.Setenv("SOLACEBROKER_USERNAME", test.EnvUsername) + os.Setenv("SOLACEBROKER_PASSWORD", test.EnvPassword) + os.Setenv("SOLACEBROKER_BEARER_TOKEN", test.EnvBearertoken) + + // Create a providerData struct from the test matrix + var username, password, bearertoken types.String + if test.ParamUsername != "" { + username = types.StringValue(test.ParamUsername) + } else { + username = types.StringNull() + } + if test.ParamPassword != "" { + password = types.StringValue(test.ParamPassword) + } else { + password = types.StringNull() + } + if test.ParamBearertoken != "" { + bearertoken = types.StringValue(test.ParamBearertoken) + } else { + bearertoken = types.StringNull() + } + providerData := &providerData{ + Username: username, + Password: password, + BearerToken: bearertoken, + Url: types.StringValue("https://example.com"), + } + _, diag := client(providerData) + // Check if the actual value is equal to the expected value + if diag != nil { + summary := diag.Summary() + if test.Expected != summary { + t.Errorf("Test %d: expected %v but got %v", testNr, test.Expected, summary) + } + } else { + if test.Expected != "" { + t.Errorf("Test %d: expected %v but got nil diag", testNr, test.Expected) + } + } + } +} diff --git a/internal/semp/client.go b/internal/semp/client.go index 9aefcf77..3635c683 100644 --- a/internal/semp/client.go +++ b/internal/semp/client.go @@ -35,9 +35,10 @@ import ( ) var ( - ErrResourceNotFound = errors.New("resource not found") - ErrBadRequest = errors.New("bad request") - ErrInvalidPath = errors.New("invalid path") + ErrResourceNotFound = errors.New("resource not found") + ErrBadRequest = errors.New("bad request") + ErrInvalidPath = errors.New("invalid path") + ErrProviderParametersError = errors.New("provider parameters error") ) var firstRequest = true @@ -48,7 +49,7 @@ type Client struct { username string password string bearerToken string - retries uint + retries int64 retryMinInterval time.Duration retryMaxInterval time.Duration requestMinInterval time.Duration @@ -81,7 +82,7 @@ func BearerToken(bearerToken string) Option { } } -func Retries(numRetries uint, retryMinInterval, retryMaxInterval time.Duration) Option { +func Retries(numRetries int64, retryMinInterval, retryMaxInterval time.Duration) Option { return func(client *Client) { client.retries = numRetries client.retryMinInterval = retryMinInterval @@ -162,9 +163,7 @@ func (c *Client) doRequest(request *http.Request) ([]byte, error) { if request.Method != http.MethodGet { request.Header.Set("Content-Type", "application/json") } - // Prefer OAuth even if Basic Auth credentials provided if c.bearerToken != "" { - // TODO: add log request.Header.Set("Authorization", "Bearer "+c.bearerToken) } else if c.username != "" { request.SetBasicAuth(c.username, c.password) diff --git a/templates/guides/config-generator.md b/templates/guides/config-generator.md index 5abfbe65..d153d74b 100644 --- a/templates/guides/config-generator.md +++ b/templates/guides/config-generator.md @@ -4,31 +4,32 @@ page_title: "Command-line Terraform Configuration Generator Guide" # Command-Line Terraform Configuration Generator -Normally, provider binaries are not run standalone, they are started and their services are used by Terraform CLI. +Normally, provider binaries are not run standalone, they are started, and their services are used by Terraform CLI. The `solacebroker` provider, however, includes an additional feature where you can run its binary outside of Terraform CLI. In this case, you can use the "generate" command on the provider binary to generate a Terraform HCL configuration file for a specified object and all its child objects known to the provider. You can [locate](https://terra-farm.github.io/main/installation.html) the provider binary in the `.terraform/providers` directory of an existing Terraform configuration directory that uses the `solacebroker` provider. -## Important notes +## Important Reminders and Tips You should review the generated configuration for the following: -* The provider block values in the generated configuration (URL, username, etc.) are exposed via Terraform input variables. Some write-only and related attribute values may also be assigned from input variables. It is recommended to check the variables created by the generator: you will need to assign value to those variables when applying the configuration or Terraform will prompt for the variable value. -* Some optional write-only attributes that cannot be determined by the generator if they were configured, are omitted from the generated configuration. You may need to add them manually. +* The provider block values in the generated configuration (URL, username, etc.) are exposed via Terraform input variables. Certain write-only and related attribute values may also be assigned from input variables. We recommend that you check the variables created by the generator: you will need to assign value to those variables when applying the configuration or Terraform will prompt for the variable value. +* Certain optional write-only attributes may not be included in the generated configuration if the generator cannot determine if they were configured. You may need to manually add these attributes. * Default resources may be present that you can omit. -* It may be required to add a "depends_on" meta-argument between generated objects. Refer to the "System provisioned objects" section. +* You my need to add a "depends_on" meta-argument between generated objects. For details, see the "System Provisioned Objects" section. * The generator uses a naming scheme for the resources. You can update this by manually replacing the generated names. ## Usage ` generate [flags] ` -* `` is the broker provider binary. +* `` is the event broker provider binary. * `[flags]` are the [supported parameters](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/guides/config-generator#supported-parameters), which mirror the [configuration options for the provider object](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs#schema), for example `--url=https://localhost:1943`. Parameters can alternatively be set via environment variables, for this example through setting `SOLACEBROKER_URL`. * `` is the address of the specified object instance in the generated configuration, in the form of `.` (for example `solacebroker_msg_vpn.myvpn`). * `` is the import identifier of the specified object instance as in the Terraform Import command. The import identifier is available from the documentation of each resource type. * `` is the name of the generated file. + This generator supports obtaining the configuration of software event brokers and will fail if applied against an appliance. This check may be overridden by setting the SOLACEBROKER_SKIP_API_CHECK=true environment variable. Example: @@ -36,13 +37,13 @@ Example: SOLACEBROKER_USERNAME=admin SOLACEBROKER_PASSWORD=admin terraform-provider-solacebroker generate --url=https://localhost:8080 solacebroker_msg_vpn_queue.q default/test my-message-vpn-queue.tf ``` -This will generate the configuration for queue `test` in message VPN `default`, and the configuration of all children, for example all subscriptions that have been configured to this queue. +This command generates the configuration for queue `test` in Message VPN `default`, and the configuration of all children, for example all subscriptions that have been configured for this queue. -### Supported parameters +### Supported Parameters The following parameters can be set as flags or environment variables (flags take precedence if both defined): -| Parameter | Required | Flag | Env var | Default | +| Parameter | Required | Flag | Environment Variable | Default | |------------------------------- |-----------|-----------------------|------------------------------|---------| | url | Yes | --url | SOLACEBROKER_URL | None | | username (Note1) | Yes | --username | SOLACEBROKER_USERNAME | None | @@ -58,19 +59,19 @@ The following parameters can be set as flags or environment variables (flags tak Note1: Only one authentication method can be used at a time: either bearer-token or username/password. -## Attribute generation +## Attribute Generation For each object, all attributes will be generated as attributes on the corresponding resource with the exception of: -* attributes that are at the default value (as per the broker version corresponding to the broker provider) +* attributes that are at the default value (as per the event broker version corresponding to the event broker provider) * write-only attributes that cannot be determined if they were configured (not coupled with another non write-only attribute) Write-only attributes that are coupled with another non write-only attribute will be generated as variable references. Variables for coupled attributes that are not write-only will have a commented-out default value with the value of the attribute, which you can choose to uncomment. Having no default means that Terraform will prompt for the variable value. -## System provisioned objects +## System Provisioned Objects -System provisioned broker objects are created as a side-effect of creating other objects. These other objects are referred to as "parent object". The generator is attempting to recognize system provisioned objects and omit them from the configuration or add a warning comment, as direct creation of such objects will fail. +System provisioned event broker objects are created as a side-effect of creating other objects. These other objects are referred to as "parent objects". The generator is attempting to recognize system provisioned objects and omit them from the configuration or add a warning comment, as direct creation of such objects will fail. -If an object's attribute is referencing a possible system-provisioned object, there may be a conflict at apply-time if the referenced object has not yet been created. The generator will add a comment when recognizing such references and it may be necessary to add a "depends_on" meta-argument between the referencoing and the parent objects to ensure proper create sequence. +If an object's attribute is referencing a possible system-provisioned object, there may be a conflict at apply-time if the referenced object has not yet been created. The generator will also add a comment when recognizing such possible references and it may be necessary to add a "create first" relationship using the Terraform "depends_on" meta-argument from the referencing resource to the system-provisioned object's parent resource to ensure proper create sequence. ## Troubleshooting @@ -78,13 +79,13 @@ The following issues may arise while using the generator. | Error | SEMP call failed. unexpected status 401 (401 Unauthorized) | |-----------------|----------------------------------------------------------------------------| -| Explanation | Configurations to connect to the PubSub+ broker not accurate. | -| Possible Action | Check and confirm, configuration details to PubSub+ broker are accurate. | +| Explanation | This indicates that the configuration details used to connect to the PubSub+ event broker are not accurate. | +| Possible Action | Verify that the configuration details used to connect to the PubSub+ event broker are accurate. | | Error | SOLACEBROKER_xxx is mandatory but not available | |-----------------|------------------------------------------------------------------------------------| -| Explanation | A mandatory parameter which is required to connect to PubSub+ broker is missing. | -| Possible Action | Confirm if all [mandatory parameters](#supported-options) are correctly set. | +| Explanation | This indicates that a mandatory parameter which is required to connect to the PubSub+ event broker is missing. | +| Possible Action | Verify that all [mandatory parameters](#supported-options) are correctly set. | | Error | Error: Too many provider specific identifiers. Required identifiers: [{xxx}] | |-----------------|------------------------------------------------------------------------------| @@ -94,7 +95,7 @@ The following issues may arise while using the generator. | Error | SEMP called failed. resource not found on path /xxx/xxx | |-----------------|------------------------------------------------------------------------------------------| | Explanation | This indicates the resource attributes attempted to be fetched could not be read. | -| Possible Action | Ensure identifiers values are consistent as set on the PubSub+ broker configured with. | +| Possible Action | Ensure identifiers values are consistent as set on the PubSub+ event broker configured with. | | Error | Error: Broker resource not found by terraform name xxx | |-----------------|------------------------------------------------------------------------------------------------------------| @@ -103,5 +104,5 @@ The following issues may arise while using the generator. | Error | Error: Broker check failed | |-----------------|-------------------------------------------------------------------------------------------------------------| -| Explanation | This indicates that broker platform does not match provider supported platform | -| Possible Action | Ensure that an appliance provider is used against a software broker platform and not an appliance platform. | +| Explanation | This indicates that the specified event broker platform is not supported by the provider | +| Possible Action | Ensure that a software broker provider binary is used against a software broker platform and not an appliance platform. | diff --git a/templates/guides/provider.md b/templates/guides/provider.md index a86fe4e0..df1a4ab8 100644 --- a/templates/guides/provider.md +++ b/templates/guides/provider.md @@ -12,21 +12,21 @@ This provider supports configuring software event brokers and will fail if appli ## Mapping of SEMP API and Provider Names -Terraform uses the [snake case](https://en.wikipedia.org/wiki/Snake_case) naming scheme, while SEMP uses camel case. Resources and datasource are also prefixed with the provider local name, `solacebroker_`. For example, `solacebroker_msg_vpn` is the message-vpn resource name and `max_subscription_count` is the attribute for the maximum subscription count, since `MsgVpn` is the SEMP API object name and `maxSubscriptionCount` is the name of the SEMP attribute. +Terraform uses the [snake case](https://en.wikipedia.org/wiki/Snake_case) naming scheme, while SEMP uses camel case. Resources and datasource are also prefixed with the provider local name, `solacebroker_`. For example, `solacebroker_msg_vpn` is the Message VPN resource name and `max_subscription_count` is the attribute for the maximum subscription count, since `MsgVpn` is the SEMP API object name and `maxSubscriptionCount` is the name of the SEMP attribute. -## Broker SEMP API Access +## Event Broker SEMP API Access The broker SEMP service, by default at port 8080 for HTTP and TLS port 1943 for HTTPS, must be accessible to the console running Terraform CLI. -The supported access credentials are basic authentication using username and password, and OAuth using a token. The two options are mutually exclusive and the provider will fail if both are configured. +The supported access credentials are basic authentication using username and password, and OAuth using a token. The two options are mutually exclusive, and the provider will fail if both are configured. -> The [user access levels](https://docs.solace.com/Admin/CLI-User-Access-Levels.htm) associated with the credentials used must be properly configured on the broker so that the desired actions are authorized. -## SEMP API Versioning and Provider Broker Compatibility +## SEMP API Versioning and Provider Event Broker Compatibility The SEMP API minor version reflects the supported set of objects, attributes, their properties and possible deprecations. -New versions of the PubSub+ event broker with new features typically require a newer SEMP API version that supports the new or updated objects, attributes, etc. The SEMP API version of a broker version can be determined from the [Solace PubSub+ documentation](https://docs.solace.com/Admin/SEMP/SEMP-API-Versions.htm#SEMP_v2_to_SolOS_Version_Mapping). +New versions of the PubSub+ event broker with new features typically require a newer SEMP API version that supports the new or updated objects, attributes, etc. The SEMP API version of an event broker version can be determined from the [Solace PubSub+ documentation](https://docs.solace.com/Admin/SEMP/SEMP-API-Versions.htm#SEMP_v2_to_SolOS_Version_Mapping). A given version of the provider is built to support a specific version of the SEMP API. For the SEMP API version of the provider and corresponding broker version, refer to the [Version Compatibility section](https://docs.solace.com/Admin/SEMP/Declarative-SEMP.htm#Version) of the Solace PubSub+ documentation. @@ -36,7 +36,7 @@ A given version of the provider is built to support a specific version of the SE ## Object Relationships -Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "Identifying" attributes that give a hint to required pre-existing objects. +Event Broker inter-object references must be correctly encoded in Terraform configuration to have the apply operation work. This requires an understanding of the PubSub+ event broker objects. For more information about each object consult the [SEMP API reference](https://docs.solace.com/API-Developer-Online-Ref-Documentation/swagger-ui/software-broker/config/index.htm) and especially look for "required" attributes that give a hint to required pre-existing objects. For example: ```terraform @@ -64,28 +64,47 @@ The Broker object differs from all other objects as it always exists for a given ## Default Objects -There are objects that are preexisting defaults and cannot be created or destroyed, only updated. The default Message VPN and the default client profile are examples of this. Any attempt to remove these resources will fail. +There are objects that are preexisting defaults and cannot be created or destroyed, only updated. The default Message VPN and the default client profile are examples of this. Any direct attempt to remove these resources will fail. If the parent object is not a default object then deleting that parent will also remove its child default object. + +> If, for example, a configuration includes creating a non-default Message VPN and modifying its default client profile, then when destroying the configuration the provider would report an error about removing the client profile. However, the client profile object will be eventually deleted because the whole Message VPN will also be deleted, which includes the default client profile. ## Broker-Defined Attributes -Some attributes don't have a default value. In this case their value will be determined by the broker. Typically, these defaults depend on the broker scaling settings. While Terraform plan and apply operations function the same way as with other attributes, import will set the Terraform state of the attribute to the broker value (instead of null), even if they were set at default. You can use subsequent plan and apply operations to fix this. +Some attributes don't have a default value. In this case their value will be determined by the broker. Typically, these defaults depend on the broker scaling settings. While Terraform plan and apply operations function the same way as with other attributes, import will set the Terraform state of the attribute to the broker value (instead of null), even if they were set at default. You can use subsequent plan and apply operations to fix this. + +## Object Type Attributes + +An object type attribute is a collection of attributes, for example `"event_ingress_msg_rate_threshold": { "clear_value": 2000000, "set_value": 5000000 }`. Note that due to Terraform provider framework limitations, there is no error reported when configuring unknown nested attributes in object type attributes. + +## Resource Replace Behavior + +In-place update of some resources is not possible at configuration change and instead the resource will be replaced for the change to occur. + +Generally, changing a "required" attribute requires the replace of any resource because the changed attribute will identify a new resource. Optional attributes that are marked as "requires-replacement" in the [provider resources documentation](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs) also cause replace of the resource. + +> Important: If a resource is replaced because of a change, its child resources will be deleted and not automatically restored. Running `terraform plan` after the resource has been replaced will reveal the missing child objects to be restored and a subsequent `terraform apply` will be required to restore those child resources. For example, changing the `direct_only_enabled` attribute of the `dmr_cluster` resource will delete all child resources such as `dmr_cluster_link`. ## Importing Resources -When [importing resources to Terraform](https://developer.hashicorp.com/terraform/language/import#syntax) an `id` is required. This `id` shall be constructed as a path from the highest parent object down to the resource. +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. -For example, when importing a `solacebroker_msg_vpn_queue_subscription`, the parent relationship is `msg_vpn` > `msg_vpn_queue` > `msg_vpn_queue_subscription`. To construct the `id`, concatenate the identifications of parents and the particular resource identification, separated by `/` (slash). Also note that elements containing `/` must be URL-encoded. +We recommend using the following procedure to import a resource: -For this example: -``` -id = // -# using my-vpn, my-queue, a/b/c -id = my-vpn/my-queue/a%2Fb%2Fc -``` +1. Add the desired resource block with the type and a name for the required resource to the Terraform config file. At a minimum, provide the required attributes. The list of required attributes is available from the resource documentation. Alternatively, you can get most attributes for the required resource (except for sensitive ones) from using the [configuration generator](https://registry.terraform.io/providers/SolaceProducts/solacebroker/latest/docs/guides/config-generator). +1. Use the `terraform import` command to get the resource to the state file. +1. Test the new resource by running `terraform plan`. If all the non-default attributes were added correctly it should show no need to update. If there is any diff, then the indicated attributes should be updated until the plan shows no change. + +> Note: Terraform import will only write actual values to the state file for attributes that are set to a non-default value. The value of attributes with default value will be imported as `null`. + +## PubSub+ Cloud Notes + +* Applying a Message VPN resource configuration to a PubSub+ Cloud broker may cause issues with attributes that are not authorized to be set in PubSub+ Cloud. This can be resolved by removing or commenting out the attributes in the configuration that are reported to be conflicting with the authorization access level. +* Similarly, attempting to delete the configuration of a Message VPN using `terraform destroy` is also expected to fail because of the insufficient authorization access level of the PubSub+ Cloud user. -## Notes +## Notes and Limitations * Terraform `apply` is not atomic. If interrupted by a user, failure, reboot, or switchover the configuration changes may be partly applied. Terraform does not perform rollbacks. * Terraform must be the authoritative source of configuration. If there is any overlap between Terraform controlled configuration and either pre-existing configuration or modifications from other management interfaces the behaviour will be undefined. * Apply operations may impact broker AD performance, especially large changes. The `request_min_interval` attribute on the provider limits the request rate and can be adjusted to control the impact. -* Application of configuration may cause brief service interruptions to the resources affected. These can include a queue missing a published message or clients being briefly disconnected. These outages are no different from a current administrator manually making an equivalent change to a broker. \ No newline at end of file +* Application of configuration may cause brief service interruptions to the resources affected. These can include a queue missing a published message or clients being briefly disconnected. These outages are no different from a current administrator manually making an equivalent change to a broker. +* Avoid creating multiple resource blocks for the same resource (where all identifying attributes are the same) as this can result in issues: the same broker resource will be present in the state under multiple different Terraform resource names and removing a resource block may cause the resource to be deleted on the broker, while the other resource name in the state still refers to that resource. \ No newline at end of file diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 1ef047fb..31e1b3d4 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -22,6 +22,10 @@ This provider also offers the possibility to generate an [HCL configuration](htt Use the navigation to the left for more information in the guides and for the available provider resources and data sources. +## Limitations + +> This version of the PubSub+ Terraform provider is generally available for production services contained within a Message VPN. Use of any resource not contained within a Message VPN is not supported in production by Solace. + ## Minimum broker version The minimum required PubSub+ Software Event Broker version is 10.4. @@ -37,4 +41,4 @@ For example, the password attribute can be set via the `SOLACEBROKER_PASSWORD` e # Release Notes and History -For detailed release notes and release history, refer to the Releases section in the [Provider GitHub repository](https://github.com/SolaceProducts/terraform-provider-solacebrokerappliance/releases). +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/third-party-licenses.txt b/third-party-licenses.txt index 3d4c9063..581b3eb9 100644 --- a/third-party-licenses.txt +++ b/third-party-licenses.txt @@ -22,19 +22,19 @@ Copyright 2010 Copyright 2010 The Go Authors Home page: https://pkg.go.dev/github.com/GoLang/protobuf@v1.5.4 -github.com/fatih/color-v1.16.0 +github.com/fatih/coloR-v1.17.0 ------------------------------ Licensed under MIT Copyright 2013 Copyright 2013 Fatih Arslan -Home page: https://pkg.go.dev/github.com/fatih/color@v1.16.0 +Home page: https://pkg.go.dev/github.com/fatih/coloR@v1.17.0 -github.com/hashiCorp/go-retryablehttp-v0.7.5 +github.com/hashiCorp/go-retryablehttp-v0.7.7 -------------------------------------------- Licensed under Mozilla 2.0 Copyright 2015 Copyright 2015 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashiCorp/go-retryablehttp@v0.7.5 +Home page: https://pkg.go.dev/github.com/hashiCorp/go-retryablehttp@v0.7.7 github.com/hashicorp/go-UuID-v1.0.3 ----------------------------------- @@ -43,11 +43,12 @@ Copyright 2015-2022 Copyright 2015-2022 HashiCorp, Inc Home page: https://pkg.go.dev/github.com/hashicorp/go-UuID@v1.0.3 -github.com/hashicorp/go-Version-v1.6.0 +github.com/hashicorp/go-Version-v1.7.0 -------------------------------------- Licensed under Mozilla 2.0 +Copyright 2014 Copyright 2014 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/go-Version@v1.6.0 +Home page: https://pkg.go.dev/github.com/hashicorp/go-Version@v1.7.0 github.com/hashicorp/go-cleanhttp-v0.5.2 ---------------------------------------- @@ -62,19 +63,19 @@ Copyright 2017 Copyright 2017 HashiCorp, Inc Home page: https://pkg.go.dev/github.com/hashicorp/go-hcLog@v1.6.3 -github.com/hashicorp/go-plugin-v1.6.0 +github.com/hashicorp/go-plugin-v1.6.1 ------------------------------------- Licensed under Mozilla 2.0 Copyright 2016 Copyright 2016 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/go-plugin@v1.6.0 +Home page: https://pkg.go.dev/github.com/hashicorp/go-plugin@v1.6.1 -github.com/hashicorp/terraform-plugin-framework-v1.8.0 +github.com/hashicorp/terraform-plugin-framework-v1.9.0 ------------------------------------------------------ Licensed under Mozilla 2.0 Copyright 2021 Copyright 2021 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework@v1.8.0 +Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework@v1.9.0 github.com/hashicorp/terraform-plugin-framework-validators-v0.12.0 ------------------------------------------------------------------ @@ -83,12 +84,12 @@ Copyright 2022 Copyright 2022 HashiCorp, Inc Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-validators@v0.12.0 -github.com/hashicorp/terraform-plugin-go-v0.22.2 +github.com/hashicorp/terraform-plugin-go-v0.23.0 ------------------------------------------------ Licensed under Mozilla 2.0 Copyright 2020 Copyright 2020 HashiCorp, Inc -Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go@v0.22.2 +Home page: https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go@v0.23.0 github.com/hashicorp/terraform-plugin-log-v0.9.0 ------------------------------------------------ @@ -142,10 +143,10 @@ Licensed under Apache 2.0 No copyright. Home page: https://pkg.go.dev/github.com/oklog/Run@v1.1.0 -github.com/spf13/cobra-v1.8.0 +github.com/spf13/cobra-v1.8.1 ----------------------------- Licensed under Apache 2.0 -Home page: https://pkg.go.dev/github.com/spf13/cobra@v1.8.0 +Home page: https://pkg.go.dev/github.com/spf13/cobra@v1.8.1 github.com/spf13/pflag-v1.0.5 ----------------------------- @@ -169,45 +170,45 @@ Copyright 2019 Copyright 2019 The github.com/vmihailenco/tagparser Authors Home page: https://pkg.go.dev/github.com/vmihailenco/tagparser/v2@v2.0.0 -golang.org/x/net-v0.24.0 +golang.org/x/net-v0.26.0 ------------------------ Licensed under Golang BSD + Patents Copyright 2009 Copyright 2009 The Go Authors -Home page: https://pkg.go.dev/golang.org/x/net@v0.24.0 +Home page: https://pkg.go.dev/golang.org/x/net@v0.26.0 -golang.org/x/sys-v0.19.0 +golang.org/x/sys-v0.21.0 ------------------------ Licensed under Golang BSD + Patents Copyright 2009 Copyright 2009 The Go Authors -Home page: https://pkg.go.dev/golang.org/x/sys@v0.19.0 +Home page: https://pkg.go.dev/golang.org/x/sys@v0.21.0 -golang.org/x/text-v0.14.0 +golang.org/x/text-v0.16.0 ------------------------- Licensed under Golang BSD + Patents Copyright 2009 Copyright 2009 The Go Authors -Home page: https://pkg.go.dev/golang.org/x/text@v0.14.0 +Home page: https://pkg.go.dev/golang.org/x/text@v0.16.0 -google.golang.org/genproto/googleapis/rpc-v0.0.0-20240429193739-8cf5692501f6 +google.golang.org/genproto/googleapis/rpc-v0.0.0-20240610135401-a8a62080eff3 ---------------------------------------------------------------------------- Licensed under Apache 2.0 -Home page: https://pkg.go.dev/google.golang.org/genproto/googleapis/rpc@v0.0.0-20240429193739-8cf5692501f6 +Home page: https://pkg.go.dev/google.golang.org/genproto/googleapis/rpc@v0.0.0-20240610135401-a8a62080eff3 -google.golang.org/grpc-v1.63.2 +google.golang.org/grpc-v1.64.0 ------------------------------ Licensed under Apache 2.0 Copyright 2014 Copyright 2014 gRPC authors -Home page: https://pkg.go.dev/google.golang.org/grpc@v1.63.2 +Home page: https://pkg.go.dev/google.golang.org/grpc@v1.64.0 -google.golang.org/protobuf-v1.34.0 +google.golang.org/protobuf-v1.34.2 ---------------------------------- Licensed under Golang BSD + Patents Copyright 2018 Copyright 2018 The Go Authors -Home page: https://pkg.go.dev/google.golang.org/protobuf@v1.34.0 +Home page: https://pkg.go.dev/google.golang.org/protobuf@v1.34.2 LICENSE REQUIREMENTS & SPECIFICATIONS diff --git a/version.go b/version.go index dfa2d744..32b7b201 100644 --- a/version.go +++ b/version.go @@ -16,4 +16,4 @@ package main -const version = "0.9.3-rc.6" +const version = "1.0.0"