Skip to main content

_nifectl orgs_

Commands for managing Nife organizations

About

Commands for managing Nife organizations. list, create, show and destroy organizations. Organization admins can also invite or remove users from Organizations.

Usage

nifectl orgs [command] [flags]

Available Commands

  • create - Create an organization
  • default - Set a default organiation
  • delete - Delete an organization
  • invite - Invite user (by email) to organization
  • migrate - Migrate an organization
  • regions - Default regions to the Organization
  • list - Lists organizations for current user
  • show - Show information about an organization

Options

-h, --help help for orgs

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

See Also

nifectl orgs create

Create an organization

About

Create a new organization. Other users can be invited to join the organization later.

Usage

nifectl orgs create <org> [flags]

Options

-h, --help help for create

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

nifectl orgs delete

Delete an existing organization.

Usage

nifectl orgs delete <org> [flags]

Options

-h, --help help for delete

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

nifectl orgs invite

Invite a user, by email, to join organization

About

Invite a user, by email, to join organization. The invitation will be sent, and the user will be pending until they respond.

Usage

nifectl orgs invite [flags]

Options

-h, --help help for list

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

nifectl orgs list

Lists organizations available to current user.

Usage

nifectl orgs list [flags]

Options

-h, --help help for list

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

nifectl orgs show

Show information about an organization

About

Shows information about an organization. Includes name, slug and type. Summarizes user permissions, DNS zones and associated member. Details full list of members and roles.

Usage

nifectl orgs show <org> [flags]

Options

-h, --help help for show

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

nifectl orgs default

Change the default organization to another organization

Usage

nifectl orgs default [flags]

Options

-h, --help help for default

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

nifectl orgs region

More default regions can be added to the Organization.

Usage

nifectl orgs regions [flags]

Options

-h, --help help for regions

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output

nifectl orgs migrate

Migrate an organization to another Organization. Which includes Apps, Sub-Organization, Business Units, Workloads inside the Organizaion will be migrated to the other Organization

Usage

nifectl orgs migrate [flags]

Options

-h, --help help for migrate

Global Options

-t, --access-token string Nife API Access Token
-j, --json json output