6.6 Library

Library definitions and definition examples are shown below. For details on Library, see “Library”.

(Table) Library definitions

Label Default value Required* Description
apiVersion: Yes API version
Specify 1.0.
kind: Yes Specify "library".
type: No Specify "container".
It indicates that this is the definition for creating a container to store documents.
name: Yes Internal name of the Library 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. This can be written using the template function.
nameRule: No -
type: fixed No Naming rule for documents stored in the container.
Only "fixed" can be specified.
items: Yes -
- name: Yes Internal name of the item folder in the container.
  label: Yes Display name of the item folder in the container. The template function can be used.
  description: No Detailed description of the item folder in the container. The template function can be used.
*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: library
type: container
name: Template of checklist
label: Template of checklist
description: A folder for storing the sample check list used when generating and deleting VMs

nameRule:
  type: fixed
  items:
    - name: create
      label: create
    - name: delete
      label: delete