3.6.11. Configure System Properties Using the Management CLI

Procedure 3.19. Configure System Properties Using the Management CLI

  1. Start the JBoss EAP server.
  2. Launch the Management CLI using the command for your operating system.
    For Linux:
    EAP_HOME/bin/jboss-cli.sh --connect
    For Windows:
    EAP_HOME\bin\jboss-cli.bat --connect
  3. Add a system property.
    The command you use depends on whether you are running a standalone server or a managed domain. If you are running a managed domain, you can add system properties to any or all of the servers running in that domain.
    • Add a system property on a standalone server using the following syntax:
      /system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

      Example 3.17. Add a system property to a standalone server

      [standalone@localhost:9999 /] /system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
      {"outcome" => "success"}
    • Add a system property to all hosts and servers in a managed domain using the following syntax:
      /system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

      Example 3.18. Add a system property to all servers in a managed domain

      [domain@localhost:9999 /] /system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
      {
          "outcome" => "success",
          "result" => undefined,
          "server-groups" => {"main-server-group" => {"host" => {"master" => {
              "server-one" => {"response" => {"outcome" => "success"}},
              "server-two" => {"response" => {"outcome" => "success"}}
          }}}}
      }
    • Add a system property to a host and its server instances in a managed domain using the following syntax:
      /host=master/system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

      Example 3.19. Add a system property to a host and its servers in a domain

      [domain@localhost:9999 /] /host=master/system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
      {
          "outcome" => "success",
          "result" => undefined,
          "server-groups" => {"main-server-group" => {"host" => {"master" => {
              "server-one" => {"response" => {"outcome" => "success"}},
              "server-two" => {"response" => {"outcome" => "success"}}
          }}}}
      }
    • Add a system property to a server instance in a managed domain using the following syntax:
      /host=master/server-config=server-one/system-property=PROPERTY_NAME:add(value=PROPERTY_VALUE)

      Example 3.20. Add a system property to a server instance in a managed domain

      [domain@localhost:9999 /] /host=master/server-config=server-one/system-property=property.mybean.queue:add(value=java:/queue/MyBeanQueue)
      {
          "outcome" => "success",
          "result" => undefined,
          "server-groups" => {"main-server-group" => {"host" => {"master" => {"server-one" => {"response" => {"outcome" => "success"}}}}}}
      }
      
  4. Read a system property.
    The command you use depends on whether you are running a standalone server or a managed domain.
    • Read a system property from a standalone server using the following syntax:
      /system-property=PROPERTY_NAME:read-resource

      Example 3.21. Read a system property from a standalone server

      [standalone@localhost:9999 /] /system-property=property.mybean.queue:read-resource
      {
          "outcome" => "success",
          "result" => {"value" => "java:/queue/MyBeanQueue"}
      }
      
    • Read a system property from all hosts and servers in a managed domain using the following syntax:
      /system-property=PROPERTY_NAME:read-resource

      Example 3.22. Read a system property from all servers in a managed domain

      [domain@localhost:9999 /] /system-property=property.mybean.queue:read-resource
      {
          "outcome" => "success",
          "result" => {
              "boot-time" => true,
              "value" => "java:/queue/MyBeanQueue"
          }
      }
    • Read a system property from a host and its server instances in a managed domain using the following syntax:
      /host=master/system-property=PROPERTY_NAME:read-resource

      Example 3.23. Read a system property from a host and its servers in a domain

      [domain@localhost:9999 /] /host=master/system-property=property.mybean.queue:read-resource
      {
          "outcome" => "success",
          "result" => {
              "boot-time" => true,
              "value" => "java:/queue/MyBeanQueue"
          }
      }
      
    • Read a system property from a server instance in a managed domain using the following syntax:
      /host=master/server-config=server-one/system-property=PROPERTY_NAME:read-resource

      Example 3.24. Read a system property from a server instance in a managed domain

      [domain@localhost:9999 /] /host=master/server-config=server-one/system-property=property.mybean.queue:read-resource
      {
          "outcome" => "success",
          "result" => {
              "boot-time" => true,
              "value" => "java:/queue/MyBeanQueue"
          }
      }
  5. Remove a system property.
    The command you use depends on whether you are running a standalone server or a managed domain.
    • Remove a system property from a standalone server using the following syntax:
      /system-property=PROPERTY_NAME:remove

      Example 3.25. Remove a system property from a standalone server

      [standalone@localhost:9999 /] /system-property=property.mybean.queue:remove
      {"outcome" => "success"}
    • Remove a system property from all hosts and servers in a managed domain using the following syntax:
      /system-property=PROPERTY_NAME:remove

      Example 3.26. Remove a system property from all hosts and servers in a domain

      [domain@localhost:9999 /] /system-property=property.mybean.queue:remove
      {
          "outcome" => "success",
          "result" => undefined,
          "server-groups" => {"main-server-group" => {"host" => {"master" => {
              "server-one" => {"response" => {"outcome" => "success"}},
              "server-two" => {"response" => {"outcome" => "success"}}
          }}}}
      }
      
    • Remove a system property from a host and its server instances in a managed domain using the following syntax:
      /host=master/system-property=PROPERTY_NAME:remove

      Example 3.27. Remove a system property from a host and its instances in a domain

      [domain@localhost:9999 /] /host=master/system-property=property.mybean.queue:remove
      {
          "outcome" => "success",
          "result" => undefined,
          "server-groups" => {"main-server-group" => {"host" => {"master" => {
              "server-one" => {"response" => {"outcome" => "success"}},
              "server-two" => {"response" => {"outcome" => "success"}}
          }}}}
      }
      
    • Remove a system property from a server instance in a managed domain using the following syntax:
      /host=master/server-config=server-one/system-property=PROPERTY_NAME:remove

      Example 3.28. Remove a system property from a server in a managed domain

      [domain@localhost:9999 /] /host=master/server-config=server-one/system-property=property.mybean.queue:remove
      {
          "outcome" => "success",
          "result" => undefined,
          "server-groups" => {"main-server-group" => {"host" => {"master" => {"server-one" => {"response" => {"outcome" => "success"}}}}}}
      }