summaryrefslogtreecommitdiff
path: root/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/clear_parameter_command.ex
diff options
context:
space:
mode:
Diffstat (limited to 'deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/clear_parameter_command.ex')
-rw-r--r--deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/clear_parameter_command.ex60
1 files changed, 60 insertions, 0 deletions
diff --git a/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/clear_parameter_command.ex b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/clear_parameter_command.ex
new file mode 100644
index 0000000000..3997b1b61f
--- /dev/null
+++ b/deps/rabbitmq_cli/lib/rabbitmq/cli/ctl/commands/clear_parameter_command.ex
@@ -0,0 +1,60 @@
+## This Source Code Form is subject to the terms of the Mozilla Public
+## License, v. 2.0. If a copy of the MPL was not distributed with this
+## file, You can obtain one at https://mozilla.org/MPL/2.0/.
+##
+## Copyright (c) 2007-2020 VMware, Inc. or its affiliates. All rights reserved.
+
+defmodule RabbitMQ.CLI.Ctl.Commands.ClearParameterCommand do
+ alias RabbitMQ.CLI.Core.{DocGuide, Helpers}
+
+ @behaviour RabbitMQ.CLI.CommandBehaviour
+ use RabbitMQ.CLI.DefaultOutput
+
+ def merge_defaults(args, opts) do
+ {args, Map.merge(%{vhost: "/"}, opts)}
+ end
+
+ def validate(args, _) when is_list(args) and length(args) < 2 do
+ {:validation_failure, :not_enough_args}
+ end
+
+ def validate([_ | _] = args, _) when length(args) > 2 do
+ {:validation_failure, :too_many_args}
+ end
+
+ def validate([_, _], _), do: :ok
+
+ use RabbitMQ.CLI.Core.RequiresRabbitAppRunning
+
+ def run([component_name, key], %{node: node_name, vhost: vhost}) do
+ :rabbit_misc.rpc_call(
+ node_name,
+ :rabbit_runtime_parameters,
+ :clear,
+ [vhost, component_name, key, Helpers.cli_acting_user()]
+ )
+ end
+
+ def usage, do: "clear_parameter [--vhost <vhost>] <component_name> <name>"
+
+ def usage_additional() do
+ [
+ ["<component_name>", "component name"],
+ ["<name>", "parameter name (identifier)"]
+ ]
+ end
+
+ def usage_doc_guides() do
+ [
+ DocGuide.parameters()
+ ]
+ end
+
+ def help_section(), do: :parameters
+
+ def description(), do: "Clears a runtime parameter."
+
+ def banner([component_name, key], %{vhost: vhost}) do
+ "Clearing runtime parameter \"#{key}\" for component \"#{component_name}\" on vhost \"#{vhost}\" ..."
+ end
+end