magellan/example.config.yaml at main · OpenCHAMI/magellan · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# Example config file for 'magellan'. Config files like this can be provided to
# 'magellan' in two ways:
#   - Explicitly, via the `--config` flag
#   - Implicitly, by placing the file in `$XDG_CONFIG_HOME/.config/magellan.yaml`
#     - If $XDG_CONFIG_HOME is not defined, it is assumed to be ~/.config
#
# All values set in the config file have a corresponding command and/or flag. For
# example, the 'subnet' property can also be set using the `--subnet` flag.

#
# Global flags for all commands
#

# Set number of concurrent jobs (used for scan and collect).
concurrency: 1

# Set the timeout for requests.
timeout: 30

# Set the log level.
log-level: debug

# Set path to read and write cache data.
cache: /tmp/magellan/assets.db

#
# Flags for the 'scan' command
#
scan:

  # Subnets to include in scan.
  subnet:
    - "172.16.0.0"
    - "172.21.0.0/24"

  # Subnet-mask to use with subnets only with IP addresses.
  subnet-mask: 255.255.255.0

  # Ports to include in the scan.
  port:
    - 443
    - 5000

  # Disables making additional request after scan to probe for Redfish services.
  # This is set using `--disable-probing` flag.
  disable-probing: false

  # Disables writing the results of a scan to a cache database. This is set using
  # the `--disable-caching` flag.
  disable-caching: false

  # Sets the protocol to use when making requests to BMCs.
  protocol: tcp

  # Sets the scheme to prepend to request URI when making request to BMCs.
  scheme: https

  # Sets the format to output the results of a scan.
  format: json

  # Sets the path to write the output of a scan. The output will be written in
  # the format set by the 'format' property.
  output: /tmp/magellan/assets.json

  # Sets whether to scan for BMCs or PDUs.
  include: bmcs

# Flags for the 'collect' command
collect:

  # Sets the path for a secrets file.
  secrets-file: secrets.json

  # Sets the protocol to use when making requests to BMCs.
  protocol: tcp

  # Sets the path to write the collection output.
  output-file: /tmp/magellan/nodes/nodes.json

  # Sets the directory to collection output using HIVE partitioning strategy.
  output-dir: /tmp/magellan/nodes

  # Sets whether to write output to standard output/error.
  show-output: false

  # Sets whether to force update objects sent to SMD by deleting and re-creating.
  force-update: false

  # Sets path to CA certificate to include with requests.
  cacert: cacert.pem

  # Sets collection output format.
  format: json

  # Sets the path to a BMC mappings file.
  bmc-id-map: "@mappings.json"

#
# Flags for the 'update' command
#
update:

  # Sets the scheme to use in the request URI.
  scheme: https

  # Sets request URI to download the firmware file.
  firmware-url:

  # Sets whether to allow insecure connections to the server.
  insecure: false

  # Sets whether to view the update job's status and exit.
  status: false

#
# Flags for the 'power' command
#
power:

  # Sets the path to the CA certificate.
  cacert: "cacert.pem"