# designateclient.v2.cli.zones module

class designateclient.v2.cli.zones.AXFRZoneCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  AXFR a zone

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.AXFRZoneCommand (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class designateclient.v2.cli.zones.AbandonZoneCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Abandon a zone

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.AbandonZoneCommand (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class designateclient.v2.cli.zones.AcceptTransferRequestCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Accept a Zone Transfer Request

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.AcceptTransferRequestCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.CreateTransferRequestCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Create new zone transfer request

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.CreateTransferRequestCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.CreateZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Create new zone

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.CreateZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.DeleteSharedZoneCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete a Zone Share

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.DeleteSharedZoneCommand (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class designateclient.v2.cli.zones.DeleteTransferRequestCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete a Zone Transfer Request

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.DeleteTransferRequestCommand (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class designateclient.v2.cli.zones.DeleteZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Delete zone

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.DeleteZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.DeleteZoneExportCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete a Zone Export

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.DeleteZoneExportCommand (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class designateclient.v2.cli.zones.DeleteZoneImportCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete a Zone Import

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.DeleteZoneImportCommand (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class designateclient.v2.cli.zones.ExportZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Export a Zone

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ExportZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ImportZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Import a Zone from a file on the filesystem

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ImportZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ListSharedZonesCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List Zone Shares

  columns = ['id', 'zone_id', 'target_project_id']
  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ListSharedZonesCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ListTransferAcceptsCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List Zone Transfer Accepts

  columns = ['id', 'zone_id', 'project_id', 'zone_transfer_request_id', 'status', 'key']
  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ListTransferAcceptsCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ListTransferRequestsCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List Zone Transfer Requests

  columns = ['id', 'zone_id', 'zone_name', 'project_id', 'target_project_id', 'status', 'key']
  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ListTransferRequestsCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ListZoneExportsCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List Zone Exports

  columns = ['id', 'zone_id', 'created_at', 'status']
  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ListZoneExportsCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ListZoneImportsCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List Zone Imports

  columns = ['id', 'zone_id', 'created_at', 'status', 'message']
  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ListZoneImportsCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ListZonesCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List zones

  columns = ['id', 'name', 'type', 'serial', 'status', 'action']
  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ListZonesCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.PoolMoveZoneCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Move a zone to another pool

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.PoolMoveZoneCommand (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class designateclient.v2.cli.zones.SetTransferRequestCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Set a Zone Transfer Request

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.SetTransferRequestCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.SetZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Set zone properties

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.SetZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShareZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Share a Zone

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShareZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShowSharedZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show Zone Share Details

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShowSharedZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShowTransferAcceptCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show Zone Transfer Accept

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShowTransferAcceptCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShowTransferRequestCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show Zone Transfer Request Details

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShowTransferRequestCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShowZoneCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show zone details

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShowZoneCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShowZoneExportCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show a Zone Export

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShowZoneExportCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShowZoneExportFileCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show the zone file for the Zone Export

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShowZoneExportFileCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

class designateclient.v2.cli.zones.ShowZoneImportCommand(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show a Zone Import

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger designateclient.v2.cli.zones.ShowZoneImportCommand (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

this page last updated: 2026-02-27 12:37:25

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug