Skip to content

Class: PodmanGenerateSystemd

Generate systemd unit from a pod or a container

URI: containers:PodmanGenerateSystemd

classDiagram class PodmanGenerateSystemd IacModule <|-- PodmanGenerateSystemd PodmanGenerateSystemd : after PodmanGenerateSystemd ..> string : after PodmanGenerateSystemd : container_prefix PodmanGenerateSystemd ..> string : container_prefix PodmanGenerateSystemd : dest PodmanGenerateSystemd ..> string : dest PodmanGenerateSystemd : env PodmanGenerateSystemd ..> MetaObject : env PodmanGenerateSystemd : executable PodmanGenerateSystemd ..> string : executable PodmanGenerateSystemd : name PodmanGenerateSystemd ..> label type : name PodmanGenerateSystemd : new PodmanGenerateSystemd ..> boolean : new PodmanGenerateSystemd : no_header PodmanGenerateSystemd ..> boolean : no_header PodmanGenerateSystemd : pod_prefix PodmanGenerateSystemd ..> string : pod_prefix PodmanGenerateSystemd : requires PodmanGenerateSystemd ..> string : requires PodmanGenerateSystemd : restart_policy PodmanGenerateSystemd ..> ContainerRestartPolicyEnum : restart_policy PodmanGenerateSystemd : restart_sec PodmanGenerateSystemd ..> integer : restart_sec PodmanGenerateSystemd : separator PodmanGenerateSystemd ..> string : separator PodmanGenerateSystemd : start_timeout PodmanGenerateSystemd ..> integer : start_timeout PodmanGenerateSystemd : stop_timeout PodmanGenerateSystemd ..> integer : stop_timeout PodmanGenerateSystemd : use_names PodmanGenerateSystemd ..> boolean : use_names PodmanGenerateSystemd : wants PodmanGenerateSystemd ..> string : wants

Inheritance

Slots

Name Cardinality and Range Description Inheritance
after 0..1
xsd:string		 At a later or future time; afterwards direct
container_prefix 0..1
xsd:string		 Prefix for a Container direct
dest 0..1
xsd:string		 Location where item appears, appeared, or is intended to be after transition direct
env 0..1
xsd:string		 Set environment variables direct
name 0..1
LabelType		 A human-readable name for an attribute or entity direct
new 0..1
xsd:string		 Produced, introduced, or discovered recently or now for the first time; not e... direct
no_header 0..1
xsd:boolean		 Do not generate the header including meta data direct
pod_prefix 0..1
xsd:string		 Prefix for a Pod direct
requires 0..*
xsd:string		 Specify one or more requirements direct
restart_policy 0..1
xsd:string		 Restart policy to follow when entity exits direct
restart_sec 0..1
xsd:string		 Time to sleep before restart direct
separator 0..1
xsd:string		 Sequence of one or more characters used to specify the boundary between separ... direct
start_timeout 0..1
xsd:integer		 Timeout (in seconds) to start a process direct
stop_timeout 0..1
xsd:integer		 Timeout (in seconds) to stop a process direct
use_names 0..1
xsd:boolean		 Use names direct
wants 0..*
xsd:string		 Wanted things direct
executable 0..1
xsd:string		 Podman executable name or full path IacModule

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/lmodel/ucs-containers

Mappings

Mapping Type Mapped Value
self containers:PodmanGenerateSystemd
native containers:PodmanGenerateSystemd

LinkML Source

Direct

name: PodmanGenerateSystemd
description: Generate systemd unit from a pod or a container
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slots:
- after
- container_prefix
- dest
- env
- name
- new
- no_header
- pod_prefix
- requires
- restart_policy
- restart_sec
- separator
- start_timeout
- stop_timeout
- use_names
- wants
slot_usage:
  after:
    name: after
    description: Add the systemd unit after (After=) option, that ordering dependencies
      between the list of dependencies and this service.  This option may be specified
      more than once.  User-defined dependencies will be appended to the generated
      unit file. But any existing options such as needed or defined by default (e.g.
      online.target) will not be removed or overridden.  Only with Podman 4.0.0 and
      above
    multivalued: true
    domain_of:
    - PodmanGenerateSystemd
  container_prefix:
    name: container_prefix
    description: Set the systemd unit name prefix for containers. If not set, use
      the default defined by podman, container. Refer to podman-generate-systemd(1)
      man page for more information.
    domain_of:
    - PodmanGenerateSystemd
  dest:
    name: dest
    description: Destination of the generated systemd unit file(s)
    domain_of:
    - PodmanExport
    - PodmanGenerateSystemd
    - PodmanImage
    - PodmanSave
  env:
    name: env
    description: Set environment variables to the systemd unit files. Keys are the
      environment variable names, and values are the environment variable values.
      Only with Podman 4.3.0 and above
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: MetaObject
  executable:
    name: executable
    description: Podman executable name or full path
    ifabsent: string(podman)
    domain_of:
    - IacModule
  name:
    name: name
    description: Name of the pod or container to export
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    - PodmanImage
    - PodmanNetwork
    - PodmanPod
    - PodmanSecret
    - PodmanVolume
    - Attribute
    - Entity
    required: true
  new:
    name: new
    description: Generate unit files that create containers and pods, not only start
      them. Refer to podman-generate-systemd(1) man page for more information.
    ifabsent: 'False'
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
  no_header:
    name: no_header
    description: Do not generate the header including meta data such as the Podman
      version and the timestamp.
    ifabsent: 'False'
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
  pod_prefix:
    name: pod_prefix
    description: Set the systemd unit name prefix for pods. If not set, use the default
      defined by podman, pod. Refer to podman-generate-systemd(1) man page for more
      information.
    domain_of:
    - PodmanGenerateSystemd
  requires:
    name: requires
    description: Set the systemd unit requires (Requires=) option. Similar to wants,
      but declares a stronger requirement dependency. Only with Podman 4.0.0 and above
    multivalued: true
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
  restart_policy:
    name: restart_policy
    description: Restart policy of the service
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: ContainerRestartPolicyEnum
  restart_sec:
    name: restart_sec
    description: Configures the time to sleep before restarting a service (as configured
      with restart-policy).  Takes a value in seconds. Only with Podman 4.0.0 and
      above
    domain_of:
    - PodmanGenerateSystemd
    range: integer
  separator:
    name: separator
    description: Systemd unit name separator between the name/id of a container/pod
      and the prefix. If not set, use the default defined by podman, -. Refer to podman-generate-systemd(1)
      man page for more information.
    domain_of:
    - PodmanGenerateSystemd
  start_timeout:
    name: start_timeout
    description: Override the default start timeout for the container with the given
      value in seconds. Only with Podman 4.0.0 and above
    domain_of:
    - PodmanGenerateSystemd
    range: integer
  stop_timeout:
    name: stop_timeout
    description: Override the default stop timeout for the container with the given
      value in seconds.
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: integer
  use_names:
    name: use_names
    description: Use name of the containers for the start, stop, and description in
      the unit file.
    ifabsent: 'True'
    domain_of:
    - PodmanGenerateSystemd
    range: boolean

Induced

name: PodmanGenerateSystemd
description: Generate systemd unit from a pod or a container
from_schema: https://w3id.org/lmodel/ucs-containers
rank: 1000
is_a: IacModule
slot_usage:
  after:
    name: after
    description: Add the systemd unit after (After=) option, that ordering dependencies
      between the list of dependencies and this service.  This option may be specified
      more than once.  User-defined dependencies will be appended to the generated
      unit file. But any existing options such as needed or defined by default (e.g.
      online.target) will not be removed or overridden.  Only with Podman 4.0.0 and
      above
    multivalued: true
    domain_of:
    - PodmanGenerateSystemd
  container_prefix:
    name: container_prefix
    description: Set the systemd unit name prefix for containers. If not set, use
      the default defined by podman, container. Refer to podman-generate-systemd(1)
      man page for more information.
    domain_of:
    - PodmanGenerateSystemd
  dest:
    name: dest
    description: Destination of the generated systemd unit file(s)
    domain_of:
    - PodmanExport
    - PodmanGenerateSystemd
    - PodmanImage
    - PodmanSave
  env:
    name: env
    description: Set environment variables to the systemd unit files. Keys are the
      environment variable names, and values are the environment variable values.
      Only with Podman 4.3.0 and above
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: MetaObject
  executable:
    name: executable
    description: Podman executable name or full path
    ifabsent: string(podman)
    domain_of:
    - IacModule
  name:
    name: name
    description: Name of the pod or container to export
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    - PodmanImage
    - PodmanNetwork
    - PodmanPod
    - PodmanSecret
    - PodmanVolume
    - Attribute
    - Entity
    required: true
  new:
    name: new
    description: Generate unit files that create containers and pods, not only start
      them. Refer to podman-generate-systemd(1) man page for more information.
    ifabsent: 'False'
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
  no_header:
    name: no_header
    description: Do not generate the header including meta data such as the Podman
      version and the timestamp.
    ifabsent: 'False'
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
  pod_prefix:
    name: pod_prefix
    description: Set the systemd unit name prefix for pods. If not set, use the default
      defined by podman, pod. Refer to podman-generate-systemd(1) man page for more
      information.
    domain_of:
    - PodmanGenerateSystemd
  requires:
    name: requires
    description: Set the systemd unit requires (Requires=) option. Similar to wants,
      but declares a stronger requirement dependency. Only with Podman 4.0.0 and above
    multivalued: true
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
  restart_policy:
    name: restart_policy
    description: Restart policy of the service
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: ContainerRestartPolicyEnum
  restart_sec:
    name: restart_sec
    description: Configures the time to sleep before restarting a service (as configured
      with restart-policy).  Takes a value in seconds. Only with Podman 4.0.0 and
      above
    domain_of:
    - PodmanGenerateSystemd
    range: integer
  separator:
    name: separator
    description: Systemd unit name separator between the name/id of a container/pod
      and the prefix. If not set, use the default defined by podman, -. Refer to podman-generate-systemd(1)
      man page for more information.
    domain_of:
    - PodmanGenerateSystemd
  start_timeout:
    name: start_timeout
    description: Override the default start timeout for the container with the given
      value in seconds. Only with Podman 4.0.0 and above
    domain_of:
    - PodmanGenerateSystemd
    range: integer
  stop_timeout:
    name: stop_timeout
    description: Override the default stop timeout for the container with the given
      value in seconds.
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: integer
  use_names:
    name: use_names
    description: Use name of the containers for the start, stop, and description in
      the unit file.
    ifabsent: 'True'
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
attributes:
  after:
    name: after
    description: Add the systemd unit after (After=) option, that ordering dependencies
      between the list of dependencies and this service.  This option may be specified
      more than once.  User-defined dependencies will be appended to the generated
      unit file. But any existing options such as needed or defined by default (e.g.
      online.target) will not be removed or overridden.  Only with Podman 4.0.0 and
      above
    from_schema: https://w3id.org/lmodel/ucs-core
    multivalued: true
    alias: after
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: string
  container_prefix:
    name: container_prefix
    description: Set the systemd unit name prefix for containers. If not set, use
      the default defined by podman, container. Refer to podman-generate-systemd(1)
      man page for more information.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: container_prefix
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: string
  dest:
    name: dest
    description: Destination of the generated systemd unit file(s)
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: dest
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanExport
    - PodmanGenerateSystemd
    - PodmanImage
    - PodmanSave
    range: string
  env:
    name: env
    description: Set environment variables to the systemd unit files. Keys are the
      environment variable names, and values are the environment variable values.
      Only with Podman 4.3.0 and above
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: env
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: MetaObject
  name:
    name: name
    description: Name of the pod or container to export
    from_schema: https://w3id.org/lmodel/ucs-core
    slot_uri: rdfs:label
    alias: name
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    - PodmanImage
    - PodmanNetwork
    - PodmanPod
    - PodmanSecret
    - PodmanVolume
    - Attribute
    - Entity
    range: label type
    required: true
  new:
    name: new
    description: Generate unit files that create containers and pods, not only start
      them. Refer to podman-generate-systemd(1) man page for more information.
    from_schema: https://w3id.org/lmodel/ucs-core
    ifabsent: 'False'
    alias: new
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
  no_header:
    name: no_header
    description: Do not generate the header including meta data such as the Podman
      version and the timestamp.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    ifabsent: 'False'
    alias: no_header
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
  pod_prefix:
    name: pod_prefix
    description: Set the systemd unit name prefix for pods. If not set, use the default
      defined by podman, pod. Refer to podman-generate-systemd(1) man page for more
      information.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: pod_prefix
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: string
  requires:
    name: requires
    description: Set the systemd unit requires (Requires=) option. Similar to wants,
      but declares a stronger requirement dependency. Only with Podman 4.0.0 and above
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    multivalued: true
    alias: requires
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: string
  restart_policy:
    name: restart_policy
    description: Restart policy of the service
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: restart_policy
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: ContainerRestartPolicyEnum
  restart_sec:
    name: restart_sec
    description: Configures the time to sleep before restarting a service (as configured
      with restart-policy).  Takes a value in seconds. Only with Podman 4.0.0 and
      above
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: restart_sec
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: integer
  separator:
    name: separator
    description: Systemd unit name separator between the name/id of a container/pod
      and the prefix. If not set, use the default defined by podman, -. Refer to podman-generate-systemd(1)
      man page for more information.
    from_schema: https://w3id.org/lmodel/ucs-core
    alias: separator
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: string
  start_timeout:
    name: start_timeout
    description: Override the default start timeout for the container with the given
      value in seconds. Only with Podman 4.0.0 and above
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: start_timeout
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: integer
  stop_timeout:
    name: stop_timeout
    description: Override the default stop timeout for the container with the given
      value in seconds.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    alias: stop_timeout
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanContainer
    - PodmanGenerateSystemd
    range: integer
  use_names:
    name: use_names
    description: Use name of the containers for the start, stop, and description in
      the unit file.
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    ifabsent: 'True'
    alias: use_names
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: boolean
  wants:
    name: wants
    description: Wanted things
    from_schema: https://w3id.org/lmodel/ucs-containers
    rank: 1000
    multivalued: true
    alias: wants
    owner: PodmanGenerateSystemd
    domain_of:
    - PodmanGenerateSystemd
    range: string
  executable:
    name: executable
    description: Podman executable name or full path
    from_schema: https://w3id.org/lmodel/ucs-core
    ifabsent: string(podman)
    alias: executable
    owner: PodmanGenerateSystemd
    domain_of:
    - IacModule
    range: string