6.7 Attachment

Attachment definitions and definition examples are shown below. For details on the Attachment, see “Storing documents”.

(Table) Attachment definitions

Label Default value Required* Description
apiVersion: Yes API version
Specify 1.0.
kind: Yes Specify "attachment".
type: No Specify "container".
It indicates that this is the definition for creating a container to store documents.
name: Yes Internal name of the Attachment definition.
"name" should follow the conventions shown below:
  • Specify the directory name of this YAML file.
  • The following characters can be entered:
    • Single-byte alphanumeric characters:
      a–z A–Z 0–9
    • Single-byte special characters:
      _ . ( ) -
  • The first character must be a single-byte alphanumeric character or an underscore (_).
  • For other precautions, see "Notes on creating YAML files" 2–4.
label: Yes Display name of the operational function to be written in the YAML file
includes: No List the related YAML files for use in this YAML file
TipsTips
  • Before this YAML file is registered, the YAML file to be written to must be registered in Ops I.
  • By specifying the "includes" label, you can import information defined in another YAML file.
- kind: Yes Type of YAML file to be loaded
  name: Yes Internal name of YAML file to be loaded
description: No Detailed description of this YAML file
nameRule: No -
type: datetime No Select a naming rule from among the following for documents stored in the container.
  • datetime:
    Name by date and time as follows. If a file with the same name exists, a number is automatically incremented at the end of the folder name.
    2021-10-01 15_15_13 UTC
    2021-10-01 15_15_13 UTC.1
    2021-10-01 15_15_13 UTC.2
  • number:
    A number is incremented. The number of digits is specified with the "length" label.
length: 5 No The number of digits when "number" is specified in the "type" label.
timezone: UTC No Time zone when "datetime" is specified in the "type" label. The following time zones can be specified.
  • UTC
  • Asia/Tokyo
*If a label that is not nested has its "Required" field set to "No", the definition is not required. For nested labels, the "Required" setting of a lower-level label applies only when the "Required" setting of its upper-level label is set to "Yes".

<Definition example>

apiVersion: 1.0
kind: attachment

type: container
name: Evidence of VM creation
label: Evidence of VM creation
description: Container to store check list during VM creation.

nameRule:
    type: datetime