8.3.1. NGCLIENT-FEATURES¶

8.3.1.1. SYNOPSIS¶

ngclient features list [options...]

ngclient features enable name [options...]

ngclient features disable name [options...]

8.3.1.2. DESCRIPTION¶

The list command is used to list available feature flags for Ngenea Hub.

The enable and disable commands can be used to enable a named feature in Ngenea Hub.

Base URL and API key settings can be read from a config file, rather than being passed on the command line. See ngenea-client.conf(5) for more information on the configuration format. CLI flags take precedence over config file settings.

Interacting with features requires Ngenea Hub authentication. The ngclient(1) authenticate command can be used to generate a client key from a username or access token.

8.3.1.3. OPTION SUMMARY¶

      name                 Name of the feature to enable or disable

    --json                 List features in json format

    --base-url             Base URL of the {{ brand_name }} API

-c, --config CONFIG        Alternative configuration file path
    --client-key KEY       Client API key to authenticate with

-h, --help                 Print help message and exit

8.3.1.3.1. OPTIONS¶

--json

List features in json format.

By default, the list command will report features in a table-based format. The --json flag will report features in json format instead, one per line.
--base-url

Base URL of the Ngenea Hub API, which operations will be performed against.

This can be used to perform Ngenea Hub operations on a remote server.

If not specified, the default is http://localhost:8000/api
-c, --config

The path to an alternative configuration file.

If not specified, the default configuration paths will be used. The default paths are in the user's HOME directory $HOME/.config/ngenea/ngenea-client.conf, and the global configuration at /etc/ngenea/ngenea-client.conf

See ngenea-client.conf(5) for more information on the configuration format.

Command line options take precedence over any corresponding config file settings.
--client-key

Ngenea Hub authentication client key.

This can be generated via the Ngenea Hub REST API, or using ngclient(1) authenticate
-h, --help

Prints the help message.

8.3.1.4. EXAMPLES¶

The following examples assume that the client key has been saved in the default config file.

8.3.1.4.1. LIST AVAILABLE FEATURES¶

$ ngclient features list
 [X]  searchui              Enable search features in the UI
 [ ]  bandwidth_controls    Enable bandwidth controls in the UI
 [ ]  rbac                  Enable role-based access controls

(The above are just examples and may not reflect actual feature flags)

8.3.1.4.2. ENABLE A FEATURE¶

ngclient features enable rbac

8.3.1.4.3. DISABLE A FEATURE¶

ngclient features disable searchui

8.3.1.5. AVAILABILITY¶

Distributed as part of the ngenea-hub-client rpm, or the ngclient wheel (Python) for non-Red Hat based systems.

The ngclient wheel can be installed and run on any operating system.

8.3.1.6. SEE ALSO¶

ngclient(1), ngenea-client.conf(5)

8.3.1.7. LICENSE¶

2021 ArcaPix Limited

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.