redfish-interop-validator 2.2.4__tar.gz → 2.2.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. {redfish_interop_validator-2.2.4/redfish_interop_validator.egg-info → redfish_interop_validator-2.2.6}/PKG-INFO +29 -29
  2. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/README.md +28 -28
  3. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/RedfishInteropValidator.py +2 -2
  4. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/RedfishLogo.py +1 -1
  5. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/config.py +2 -2
  6. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/interop.py +1 -1
  7. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/profile.py +1 -1
  8. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/redfish.py +1 -1
  9. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/session.py +1 -1
  10. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/tohtml.py +12 -7
  11. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/traverseInterop.py +5 -3
  12. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/validateResource.py +3 -3
  13. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6/redfish_interop_validator.egg-info}/PKG-INFO +29 -29
  14. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/setup.py +2 -2
  15. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/AUTHORS.md +0 -0
  16. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/LICENSE.md +0 -0
  17. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator/__init__.py +0 -0
  18. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator.egg-info/SOURCES.txt +0 -0
  19. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator.egg-info/dependency_links.txt +0 -0
  20. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator.egg-info/entry_points.txt +0 -0
  21. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator.egg-info/requires.txt +0 -0
  22. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/redfish_interop_validator.egg-info/top_level.txt +0 -0
  23. {redfish_interop_validator-2.2.4 → redfish_interop_validator-2.2.6}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: redfish_interop_validator
3
- Version: 2.2.4
3
+ Version: 2.2.6
4
4
  Summary: Redfish Interop Validator
5
5
  Home-page: https://github.com/DMTF/Redfish-Interop-Validator
6
6
  Author: DMTF, https://www.dmtf.org/standards/feedback
@@ -18,7 +18,7 @@ Requires-Dist: beautifulsoup4>=4.6.0
18
18
  Requires-Dist: lxml
19
19
  Requires-Dist: jsonschema
20
20
 
21
- Copyright 2017-2020 DMTF. All rights reserved.
21
+ Copyright 2017-2024 DMTF. All rights reserved.
22
22
 
23
23
  # Redfish Interop Validator
24
24
 
@@ -71,42 +71,42 @@ Modify the config\example.ini file to enter the system details under below secti
71
71
 
72
72
  ### [Tool]
73
73
 
74
- | Variable | Type | Definition |
75
- | :--- | :--- | :--- |
76
- | Version | string | Internal config version (optional) |
77
- | Copyright | string | _DMTF_ copyright (optional) |
78
- | verbose | int | level of verbosity (0-3) |
74
+ | Variable | CLI Argument | Type | Definition |
75
+ | :--- | :--- | :--- | :--- |
76
+ | `verbose` | `-v` | integer | Verbosity of tool in stdout; 0 to 3, 3 being the greatest level of verbosity. |
79
77
 
80
78
  ### [Interop]
81
79
 
82
- | Variable | Type | Definition |
83
- | :--- | :--- | :--- |
84
- | Profile | string | name of the testing profile (mandatory) |
85
- | Schema | string | name of json schema to test profile against |
80
+ Note: These arguments are only supplied via the CLI to the tool and are not specified in the configuration file.
81
+
82
+ | CLI Argument | Type | Definition |
83
+ | :--- | :--- | :--- |
84
+ | `profile` | string | The name of the testing profile (mandatory). |
85
+ | `--schema` | string | The filepath and name of the schema file to verify the format of the profile. |
86
86
 
87
87
  ### [Host]
88
88
 
89
- | Variable | Type | Definition |
90
- | :--- | :--- | :--- |
91
- | ip | string | Host of testing system, formatted as https:// ip : port (can use http as well) |
92
- | username | string | Username for Basic authentication |
93
- | password | string | Password for Basic authentication (removed from logs) |
94
- | description | string | Description of system being tested (optional) |
95
- | forceauth | boolean | Force authentication even on http servers |
96
- | authtype | string | Authorization type (Basic | Session | Token | None) |
97
- | token | string | Token string for Token authentication |
89
+ | Variable | CLI Argument | Type | Definition |
90
+ | :--- | :--- | :--- | :--- |
91
+ | `ip` | `-r` | string | The address of the Redfish service (with scheme); example: 'https://123.45.6.7:8000'. |
92
+ | `username` | `-u` | string | The username for authentication. |
93
+ | `password` | `-p` | string | The password for authentication. |
94
+ | `description` | `--description` | string | The description of the system for identifying logs; if none is given, a value is produced from information in the service root. |
95
+ | `forceauth` | `--forceauth` | boolean | Force authentication on unsecure connections; 'True' or 'False'. |
96
+ | `authtype` | `--authtype` | string | Authorization type; 'None', 'Basic', 'Session', or 'Token'. |
97
+ | `token` | `--token` | string | Token when 'authtype' is 'Token'. |
98
98
 
99
99
  ### [Validator]
100
100
 
101
- | Variable | Type | Definition |
102
- | :--- | :--- | :--- |
103
- | payload | string | Option to test a specific payload or resource tree (see below) |
104
- | logdir | string | Place to save logs and run configs |
105
- | oemcheck | boolean | Whether to check Oem items on service |
106
- | online_profiles | boolean | Whether to download online profiles |
107
- | debugging | boolean | Whether to print debug to log |
108
- | required_profiles_dir | string | Option to set the root folder of required profiles |
109
- | collectionlimit | string | Sets a limit to links gathered from collections by type, e.g. `ComputerSystem 20` limits ComputerSystemCollection to 20 links |
101
+ | Variable | CLI Argument | Type | Definition |
102
+ | :--- | :--- | :--- | :--- |
103
+ | `payload` | `--payload` | string | The mode to validate payloads ('Tree', 'Single', 'SingleFile', or 'TreeFile') followed by resource/filepath; see below. |
104
+ | `logdir` | `--logdir` | string | The directory for generated report files; default: 'logs'. |
105
+ | `oemcheck` | `--nooemcheck` | boolean | Whether to check OEM items on service; 'True' or 'False'. |
106
+ | `online_profiles` | `--no_online_profiles` | boolean | Whether to download online profiles; 'True' or 'False'. |
107
+ | `debugging` | `--debugging` | boolean | Output debug statements to text log, otherwise it only uses INFO; 'True' or 'False'. |
108
+ | `required_profiles_dir` | `--required_profiles_dir` | string | Option to set the root folder of required profiles |
109
+ | `collectionlimit` | `--collectionlimit` | string | Sets a limit to links gathered from collections by type (schema name).<br/>Example 1: `ComputerSystem 20` limits ComputerSystemCollection to 20 links.<br/>Example 2: `ComputerSystem 20 LogEntry 10` limits ComputerSystemCollection to 20 links and LogEntryCollection to 10 links. |
110
110
 
111
111
  ### Payload options
112
112
 
@@ -1,4 +1,4 @@
1
- Copyright 2017-2020 DMTF. All rights reserved.
1
+ Copyright 2017-2024 DMTF. All rights reserved.
2
2
 
3
3
  # Redfish Interop Validator
4
4
 
@@ -51,42 +51,42 @@ Modify the config\example.ini file to enter the system details under below secti
51
51
 
52
52
  ### [Tool]
53
53
 
54
- | Variable | Type | Definition |
55
- | :--- | :--- | :--- |
56
- | Version | string | Internal config version (optional) |
57
- | Copyright | string | _DMTF_ copyright (optional) |
58
- | verbose | int | level of verbosity (0-3) |
54
+ | Variable | CLI Argument | Type | Definition |
55
+ | :--- | :--- | :--- | :--- |
56
+ | `verbose` | `-v` | integer | Verbosity of tool in stdout; 0 to 3, 3 being the greatest level of verbosity. |
59
57
 
60
58
  ### [Interop]
61
59
 
62
- | Variable | Type | Definition |
63
- | :--- | :--- | :--- |
64
- | Profile | string | name of the testing profile (mandatory) |
65
- | Schema | string | name of json schema to test profile against |
60
+ Note: These arguments are only supplied via the CLI to the tool and are not specified in the configuration file.
61
+
62
+ | CLI Argument | Type | Definition |
63
+ | :--- | :--- | :--- |
64
+ | `profile` | string | The name of the testing profile (mandatory). |
65
+ | `--schema` | string | The filepath and name of the schema file to verify the format of the profile. |
66
66
 
67
67
  ### [Host]
68
68
 
69
- | Variable | Type | Definition |
70
- | :--- | :--- | :--- |
71
- | ip | string | Host of testing system, formatted as https:// ip : port (can use http as well) |
72
- | username | string | Username for Basic authentication |
73
- | password | string | Password for Basic authentication (removed from logs) |
74
- | description | string | Description of system being tested (optional) |
75
- | forceauth | boolean | Force authentication even on http servers |
76
- | authtype | string | Authorization type (Basic | Session | Token | None) |
77
- | token | string | Token string for Token authentication |
69
+ | Variable | CLI Argument | Type | Definition |
70
+ | :--- | :--- | :--- | :--- |
71
+ | `ip` | `-r` | string | The address of the Redfish service (with scheme); example: 'https://123.45.6.7:8000'. |
72
+ | `username` | `-u` | string | The username for authentication. |
73
+ | `password` | `-p` | string | The password for authentication. |
74
+ | `description` | `--description` | string | The description of the system for identifying logs; if none is given, a value is produced from information in the service root. |
75
+ | `forceauth` | `--forceauth` | boolean | Force authentication on unsecure connections; 'True' or 'False'. |
76
+ | `authtype` | `--authtype` | string | Authorization type; 'None', 'Basic', 'Session', or 'Token'. |
77
+ | `token` | `--token` | string | Token when 'authtype' is 'Token'. |
78
78
 
79
79
  ### [Validator]
80
80
 
81
- | Variable | Type | Definition |
82
- | :--- | :--- | :--- |
83
- | payload | string | Option to test a specific payload or resource tree (see below) |
84
- | logdir | string | Place to save logs and run configs |
85
- | oemcheck | boolean | Whether to check Oem items on service |
86
- | online_profiles | boolean | Whether to download online profiles |
87
- | debugging | boolean | Whether to print debug to log |
88
- | required_profiles_dir | string | Option to set the root folder of required profiles |
89
- | collectionlimit | string | Sets a limit to links gathered from collections by type, e.g. `ComputerSystem 20` limits ComputerSystemCollection to 20 links |
81
+ | Variable | CLI Argument | Type | Definition |
82
+ | :--- | :--- | :--- | :--- |
83
+ | `payload` | `--payload` | string | The mode to validate payloads ('Tree', 'Single', 'SingleFile', or 'TreeFile') followed by resource/filepath; see below. |
84
+ | `logdir` | `--logdir` | string | The directory for generated report files; default: 'logs'. |
85
+ | `oemcheck` | `--nooemcheck` | boolean | Whether to check OEM items on service; 'True' or 'False'. |
86
+ | `online_profiles` | `--no_online_profiles` | boolean | Whether to download online profiles; 'True' or 'False'. |
87
+ | `debugging` | `--debugging` | boolean | Output debug statements to text log, otherwise it only uses INFO; 'True' or 'False'. |
88
+ | `required_profiles_dir` | `--required_profiles_dir` | string | Option to set the root folder of required profiles |
89
+ | `collectionlimit` | `--collectionlimit` | string | Sets a limit to links gathered from collections by type (schema name).<br/>Example 1: `ComputerSystem 20` limits ComputerSystemCollection to 20 links.<br/>Example 2: `ComputerSystem 20 LogEntry 10` limits ComputerSystemCollection to 20 links and LogEntryCollection to 10 links. |
90
90
 
91
91
  ### Payload options
92
92
 
@@ -1,6 +1,6 @@
1
1
 
2
2
  # Copyright Notice:
3
- # Copyright 2016 DMTF. All rights reserved.
3
+ # Copyright 2017-2024 DMTF. All rights reserved.
4
4
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Interop-Validator/blob/master/LICENSE.md
5
5
 
6
6
  import os
@@ -17,7 +17,7 @@ import redfish_interop_validator.traverseInterop as traverseInterop
17
17
  from redfish_interop_validator.profile import getProfiles, checkProfileAgainstSchema, hashProfile
18
18
  from redfish_interop_validator.validateResource import validateSingleURI, validateURITree
19
19
 
20
- tool_version = '2.2.4'
20
+ tool_version = '2.2.6'
21
21
 
22
22
  # Set up the custom debug levels
23
23
  VERBOSE1 = logging.INFO - 1
@@ -1,5 +1,5 @@
1
1
  # Copyright Notice:
2
- # Copyright 2018-2019 DMTF. All rights reserved.
2
+ # Copyright 2017-2024 DMTF. All rights reserved.
3
3
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Service-Validator/blob/master/LICENSE.md
4
4
 
5
5
  """
@@ -1,5 +1,5 @@
1
1
  # Copyright Notice:
2
- # Copyright 2016-2021 DMTF. All rights reserved.
2
+ # Copyright 2017-2024 DMTF. All rights reserved.
3
3
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Service-Validator/blob/master/LICENSE.md
4
4
 
5
5
  import configparser
@@ -49,7 +49,7 @@ def convert_config_to_args(args, config):
49
49
  if option.lower() not in ['version', 'copyright']:
50
50
  my_logger.error('Option {} not supported!'.format(option))
51
51
  elif my_config[section][option] not in ['', None]:
52
- if option.lower() == 'payload':
52
+ if option.lower() == 'payload' or option.lower() == 'collectionlimit':
53
53
  setattr(args, option, my_config[section][option].split(' '))
54
54
  else:
55
55
  setattr(args, option, my_config[section][option])
@@ -1,6 +1,6 @@
1
1
 
2
2
  # Copyright Notice:
3
- # Copyright 2016 DMTF. All rights reserved.
3
+ # Copyright 2017-2024 DMTF. All rights reserved.
4
4
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Interop-Validator/blob/master/LICENSE.md
5
5
 
6
6
  import re
@@ -1,6 +1,6 @@
1
1
 
2
2
  # Copyright Notice:
3
- # Copyright 2016 DMTF. All rights reserved.
3
+ # Copyright 2017-2024 DMTF. All rights reserved.
4
4
  # License: BSD 3-Clause License. For full text see link:
5
5
  # https://github.com/DMTF/Redfish-Service-Validator/LICENSE.md
6
6
 
@@ -1,5 +1,5 @@
1
1
  # Copyright Notice:
2
- # Copyright 2016-2020 DMTF. All rights reserved.
2
+ # Copyright 2017-2024 DMTF. All rights reserved.
3
3
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Service-Validator/blob/master/LICENSE.md
4
4
 
5
5
  import re
@@ -1,5 +1,5 @@
1
1
  # Copyright Notice:
2
- # Copyright 2016-2019 DMTF. All rights reserved.
2
+ # Copyright 2017-2024 DMTF. All rights reserved.
3
3
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Service-Validator/blob/master/LICENSE.md
4
4
 
5
5
  from datetime import datetime, timedelta
@@ -1,6 +1,6 @@
1
1
 
2
2
  # Copyright Notice:
3
- # Copyright 2016-2020 DMTF. All rights reserved.
3
+ # Copyright 2017-2024 DMTF. All rights reserved.
4
4
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Interop-Validator/blob/master/LICENSE.md
5
5
 
6
6
 
@@ -158,20 +158,25 @@ def renderHtml(results, finalCounts, tool_version, startTick, nowTick, config):
158
158
  for cnt, item in enumerate(results):
159
159
  entry = []
160
160
  val = results[item]
161
- rtime = '(response time: {})'.format(val['rtime'])
161
+ response_time = val.get('rtime')
162
+ if isinstance(response_time, float) and response_time >= 0:
163
+ rtime = '(response time: {})'.format(response_time)
164
+ else:
165
+ rtime = ''
162
166
 
163
167
  if len(val['messages']) == 0 and len(val['errors']) == 0 and len(val['warns']) == 0:
164
168
  continue
165
169
 
166
170
  # uri block
167
- prop_type = val['fulltype']
171
+ prop_type, type_name = val['fulltype'], ''
168
172
  if prop_type is not None:
169
- namespace = getNamespace(prop_type)
170
173
  type_name = getType(prop_type)
171
174
 
172
- infos_a = [str(val.get(x)) for x in ['uri', 'samplemapped'] if val.get(x) not in ['',None]]
173
- infos_a.append(rtime)
174
- infos_a.append(type_name)
175
+ infos_a = [str(val.get(x)) for x in ['uri', 'samplemapped'] if val.get(x) not in ['', None]]
176
+ if rtime != '':
177
+ infos_a.append(rtime)
178
+ if type_name:
179
+ infos_a.append(type_name)
175
180
  uriTag = tag.tr(tag.th(infoBlock(infos_a, '&ensp;'), 'class="titlerow bluebg"'))
176
181
  entry.append(uriTag)
177
182
 
@@ -1,5 +1,5 @@
1
1
  # Copyright Notice:
2
- # Copyright 2016-2020 DMTF. All rights reserved.
2
+ # Copyright 2017-2024 DMTF. All rights reserved.
3
3
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Service-Validator/blob/master/LICENSE.md
4
4
 
5
5
  import requests
@@ -336,13 +336,13 @@ def createResourceObject(name, uri, jsondata=None, typename=None, context=None,
336
336
  """ # Create json from service or from given
337
337
 
338
338
  if jsondata is None and not isComplex:
339
- success, jsondata, status, _, response = callResourceURI(uri)
339
+ success, jsondata, status, response_time, response = callResourceURI(uri)
340
340
  traverseLogger.debug('{}, {}, {}'.format(success, jsondata, status))
341
341
  if not success:
342
342
  my_logger.error('{}: URI could not be acquired: {}'.format(uri, status))
343
343
  return None, status
344
344
  else:
345
- success, jsondata, status, _, response = True, jsondata, -1, 0, None
345
+ success, jsondata, status, response_time, response = True, jsondata, -1, 0, None
346
346
 
347
347
  # Collect our resource header
348
348
  if response:
@@ -354,6 +354,8 @@ def createResourceObject(name, uri, jsondata=None, typename=None, context=None,
354
354
 
355
355
  newResource = ResourceObj(name, uri, jsondata, typename, context, parent, isComplex, headers=my_header)
356
356
 
357
+ newResource.rtime = response_time
358
+
357
359
  return newResource, status
358
360
 
359
361
 
@@ -1,5 +1,5 @@
1
1
  # Copyright Notice:
2
- # Copyright 2016-2021 DMTF. All rights reserved.
2
+ # Copyright 2017-2024 DMTF. All rights reserved.
3
3
  # License: BSD 3-Clause License. For full text see link: https://github.com/DMTF/Redfish-Service-Validator/blob/master/LICENSE.md
4
4
 
5
5
  import logging
@@ -66,7 +66,7 @@ def validateSingleURI(URI, profile, uriName='', expectedType=None, expectedSchem
66
66
  'messages': messages,
67
67
  'errors': '',
68
68
  'warns': '',
69
- 'rtime': '',
69
+ 'rtime': 'n/a',
70
70
  'context': '',
71
71
  'fulltype': '',
72
72
  'rcode': 0,
@@ -465,7 +465,7 @@ def validateURITree(URI, profile, uriName, expectedType=None, expectedSchema=Non
465
465
  finalResults['n/a'] = {'uri': "Service Level Requirements", 'success': message_counts.get('fail', 0) == 0,
466
466
  'counts': message_counts,
467
467
  'messages': message_list, 'errors': error_messages.getvalue(), 'warns': '',
468
- 'rtime': '', 'context': '', 'fulltype': ''}
468
+ 'rtime': None, 'context': '', 'fulltype': ''}
469
469
  finalResults.update(results)
470
470
  error_messages.close()
471
471
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: redfish_interop_validator
3
- Version: 2.2.4
3
+ Version: 2.2.6
4
4
  Summary: Redfish Interop Validator
5
5
  Home-page: https://github.com/DMTF/Redfish-Interop-Validator
6
6
  Author: DMTF, https://www.dmtf.org/standards/feedback
@@ -18,7 +18,7 @@ Requires-Dist: beautifulsoup4>=4.6.0
18
18
  Requires-Dist: lxml
19
19
  Requires-Dist: jsonschema
20
20
 
21
- Copyright 2017-2020 DMTF. All rights reserved.
21
+ Copyright 2017-2024 DMTF. All rights reserved.
22
22
 
23
23
  # Redfish Interop Validator
24
24
 
@@ -71,42 +71,42 @@ Modify the config\example.ini file to enter the system details under below secti
71
71
 
72
72
  ### [Tool]
73
73
 
74
- | Variable | Type | Definition |
75
- | :--- | :--- | :--- |
76
- | Version | string | Internal config version (optional) |
77
- | Copyright | string | _DMTF_ copyright (optional) |
78
- | verbose | int | level of verbosity (0-3) |
74
+ | Variable | CLI Argument | Type | Definition |
75
+ | :--- | :--- | :--- | :--- |
76
+ | `verbose` | `-v` | integer | Verbosity of tool in stdout; 0 to 3, 3 being the greatest level of verbosity. |
79
77
 
80
78
  ### [Interop]
81
79
 
82
- | Variable | Type | Definition |
83
- | :--- | :--- | :--- |
84
- | Profile | string | name of the testing profile (mandatory) |
85
- | Schema | string | name of json schema to test profile against |
80
+ Note: These arguments are only supplied via the CLI to the tool and are not specified in the configuration file.
81
+
82
+ | CLI Argument | Type | Definition |
83
+ | :--- | :--- | :--- |
84
+ | `profile` | string | The name of the testing profile (mandatory). |
85
+ | `--schema` | string | The filepath and name of the schema file to verify the format of the profile. |
86
86
 
87
87
  ### [Host]
88
88
 
89
- | Variable | Type | Definition |
90
- | :--- | :--- | :--- |
91
- | ip | string | Host of testing system, formatted as https:// ip : port (can use http as well) |
92
- | username | string | Username for Basic authentication |
93
- | password | string | Password for Basic authentication (removed from logs) |
94
- | description | string | Description of system being tested (optional) |
95
- | forceauth | boolean | Force authentication even on http servers |
96
- | authtype | string | Authorization type (Basic | Session | Token | None) |
97
- | token | string | Token string for Token authentication |
89
+ | Variable | CLI Argument | Type | Definition |
90
+ | :--- | :--- | :--- | :--- |
91
+ | `ip` | `-r` | string | The address of the Redfish service (with scheme); example: 'https://123.45.6.7:8000'. |
92
+ | `username` | `-u` | string | The username for authentication. |
93
+ | `password` | `-p` | string | The password for authentication. |
94
+ | `description` | `--description` | string | The description of the system for identifying logs; if none is given, a value is produced from information in the service root. |
95
+ | `forceauth` | `--forceauth` | boolean | Force authentication on unsecure connections; 'True' or 'False'. |
96
+ | `authtype` | `--authtype` | string | Authorization type; 'None', 'Basic', 'Session', or 'Token'. |
97
+ | `token` | `--token` | string | Token when 'authtype' is 'Token'. |
98
98
 
99
99
  ### [Validator]
100
100
 
101
- | Variable | Type | Definition |
102
- | :--- | :--- | :--- |
103
- | payload | string | Option to test a specific payload or resource tree (see below) |
104
- | logdir | string | Place to save logs and run configs |
105
- | oemcheck | boolean | Whether to check Oem items on service |
106
- | online_profiles | boolean | Whether to download online profiles |
107
- | debugging | boolean | Whether to print debug to log |
108
- | required_profiles_dir | string | Option to set the root folder of required profiles |
109
- | collectionlimit | string | Sets a limit to links gathered from collections by type, e.g. `ComputerSystem 20` limits ComputerSystemCollection to 20 links |
101
+ | Variable | CLI Argument | Type | Definition |
102
+ | :--- | :--- | :--- | :--- |
103
+ | `payload` | `--payload` | string | The mode to validate payloads ('Tree', 'Single', 'SingleFile', or 'TreeFile') followed by resource/filepath; see below. |
104
+ | `logdir` | `--logdir` | string | The directory for generated report files; default: 'logs'. |
105
+ | `oemcheck` | `--nooemcheck` | boolean | Whether to check OEM items on service; 'True' or 'False'. |
106
+ | `online_profiles` | `--no_online_profiles` | boolean | Whether to download online profiles; 'True' or 'False'. |
107
+ | `debugging` | `--debugging` | boolean | Output debug statements to text log, otherwise it only uses INFO; 'True' or 'False'. |
108
+ | `required_profiles_dir` | `--required_profiles_dir` | string | Option to set the root folder of required profiles |
109
+ | `collectionlimit` | `--collectionlimit` | string | Sets a limit to links gathered from collections by type (schema name).<br/>Example 1: `ComputerSystem 20` limits ComputerSystemCollection to 20 links.<br/>Example 2: `ComputerSystem 20 LogEntry 10` limits ComputerSystemCollection to 20 links and LogEntryCollection to 10 links. |
110
110
 
111
111
  ### Payload options
112
112
 
@@ -1,5 +1,5 @@
1
1
  # Copyright Notice:
2
- # Copyright 2022-2023 DMTF. All rights reserved.
2
+ # Copyright 2017-2024 DMTF. All rights reserved.
3
3
  # License: BSD 3-Clause License. For full text see link:
4
4
  # https://github.com/DMTF/Redfish-Interop-Validator/blob/main/LICENSE.md
5
5
 
@@ -11,7 +11,7 @@ with open("README.md", "r", "utf-8") as f:
11
11
 
12
12
  setup(
13
13
  name="redfish_interop_validator",
14
- version="2.2.4",
14
+ version="2.2.6",
15
15
  description="Redfish Interop Validator",
16
16
  long_description=long_description,
17
17
  long_description_content_type="text/markdown",