Ceph Nvme

Learn about actions >

• add-host

  Allow a host to access an endpoint

  Params

  • dhchap-key string

    DH-CHAP key used to authenticate the host

  • hostnqn string

    The host's NQN, or the word 'any' to allow any host

  • nqn string

    The NQN of the endpoint

  Required

  hostnqn, nqn

• create-endpoint

  Create a new endpoint to back NVMe devices

  Params

  • rbd-image string

    The RBD image that will back the endpoint

  • rbd-pool string

    The RBD pool where the image is allocated

  • subnet string

    Subnet on which to pick a host on which to create the endpoint. Can be an IPv4 or IPv6 network.

  • units string

    A string denoting which other units will implement this endpoint to provide HA guarantees. It can come in 2 forms - Either an integer that specifies the number of additional units that will be used, or a comma-separated list of units ('ceph-nvme/0', for example).

  Required

  rbd-image, rbd-pool

• delete-endpoint

  Remove a previously created endpoint

  Params

  • nqn string

    The NQN of the endpoint

  Required

  nqn

• delete-host

  Remove a previously added host

  Params

  • hostnqn string

    The host's NQN

  • nqn string

    The NQN of the endpoint

  Required

  nqn, hostnqn

• join-endpoint

  Join an endpoint from a peer to provide HA

  Params

  • nmax integer

    Maximum number of endpoints to join

  • nqn string

    The NQN of the endpoint

  • subnet string

    Subnet on which to pick a host on which to create the endpoint. Can be an IPv4 or IPv6 network.

  Required

  nqn

• list-endpoints

  List the endpoints this unit supports

• list-hosts

  List the allowed hosts for an endpoint

  Params

  • nqn string

    The NQN of the endpoint

  Required

  nqn

• pause

  Pauses all the Ceph NVMe-oF services

• reset-target

  Restarts the NVMe-oF target with a clear state

• resume

  Resumes previously paused services