Skip to content

Commit

Permalink
Fix comments by Andy on about 19 march
Browse files Browse the repository at this point in the history
1. Restored text to mof_compiler.help.txt

2. Fixed merge conflict in changes.rst

fix
  • Loading branch information
KSchopmeyer committed Mar 20, 2018
1 parent 0e62e7e commit 0a55621
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 25 deletions.
31 changes: 6 additions & 25 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,7 @@ Enhancements
support. (Issue #1115).

* Revamped the logger configuration mechanism completely. This includes:
<<<<<<< HEAD
(1) Create 3 methods in WBEMConnection that allow pywbem logs to be
(1) Created 3 methods in WBEMConnection that allow pywbem logs to be
configured and activated. These methods contain parameters for:
a. configuring the Python loggers for either/or/both the api and http
loggers. b. Setting the level of detail in the log output. c. Activating
Expand All @@ -400,33 +399,15 @@ Enhancements
names that will be used by the pywbem loggers. This allows the pywbem
loggers to be compatible with user code that creates their specific logger
configurations.
(3) Completely eliminate the PyWBEMLogger class that was the original
logging setup tool in pywbem 0.11.0) since its use was incompatible with
(3) Eliminated the PyWBEMLogger class that was the original
logging setup tool in pywbem 0.11.0 since its use was incompatible with
using standard Python logging configuration methods to define loggers.
(see issue #859)
(4) Create a function in the _logging module that allows pywbem logging
to be defined by a single string input
=======
(1) Modify logging config to add new optional parameter to WBEMConnection
constructor (enable_logging) which determines if logging will be executed
for request APIs/responses and XML requests/responses. If not None
this automatically initiates logging.
(2) Remove the extra configuration parameter for detail level from the
log setup so that the standard Python logging setup can be used to
setup the loggers for pywbem WBEMConnection APIs and responses, and
the XML requests and responses.
(3) Create 2 helper functions in _logging so that a user can create the
logger definitions for these loggers with simple one line calls if they
do not want to use the Python logging handler configuration methods directly
to define the loggers.
(4) Completely eliminate the PyWBEMLogger class that was the original
logging setup tool in pywbem 0.11.0) since its use was incompatible with
using standard Python logging configuration methods to define loggers.
(see issue #859)
(5) addition of a new property to WBEMConnection (conn_id) which is a
(4) Created a function in the _logging module that allows pywbem logging
to be defined by a single string input.
(5) ddition of a new property to WBEMConnection (conn_id) which is a
unique identifier for each WBEMConnection object and is part of each log
record. This allows linking logs for each WBEMConnection in the log.
>>>>>>> af06c1c... Bring up-to-date with Andy's comments

Bug fixes
^^^^^^^^^
Expand Down
89 changes: 89 additions & 0 deletions docs/mof_compiler.help.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
usage: mof_compiler [options] moffile ...

Compile MOF files, and update a namespace in a WBEM server with the result.

Positional arguments:
moffile Path name of the MOF file to be compiled.
Can be specified multiple times.

Server related options:
Specify the WBEM server and namespace the MOF compiler works against, for
looking up existing elements, and for applying the MOF compilation results
to.

-s url, --server url Host name or URL of the WBEM server (required),
in this format:
[scheme://]host[:port]
- scheme: Defines the protocol to use:
- "https" for HTTPS protocol
- "http" for HTTP protocol
Default: "https".
- host: Defines host name as follows:
- short or fully qualified DNS hostname
- literal IPV4 address(dotted)
- literal IPV6 address (RFC 3986) with zone
identifier extensions(RFC 6874)
supporting "-" or %25 for the delimiter
- port: Defines the WBEM server port to be used.
Defaults:
- 5988, when using HTTP
- 5989, whenusing HTTPS
-n namespace, --namespace namespace
Namespace in the WBEM server.
Default: root/cimv2

Connection security related options:
Specify user name and password or certificates and keys

-u user, --user user User name for authenticating with the WBEM server.
Default: No user name.
-p password, --password password
Password for authenticating with the WBEM server.
Default: Will be prompted for, if user name
specified.
-nvc, --no-verify-cert
Client will not verify certificate returned by the
WBEM server (see cacerts). This bypasses the client-
side verification of the server identity, but allows
encrypted communication with a server for which the
client does not have certificates.
--cacerts cacerts File or directory containing certificates that will be
matched against a certificate received from the WBEM
server. Set the --no-verify-cert option to bypass
client verification of the WBEM server certificate.
Default: Searches for matching certificates in the
following system directories:
/etc/pki/ca-trust/extracted/openssl/ca-bundle.trust.crt
/etc/ssl/certs
/etc/ssl/certificates
--certfile certfile Client certificate file for authenticating with the
WBEM server. If option specified the client attempts
to execute mutual authentication.
Default: Simple authentication.
--keyfile keyfile Client private key file for authenticating with the
WBEM server. Not required if private key is part of the
certfile option. Not allowed if no certfile option.
Default: No client key file. Client private key should
then be part of the certfile

Action related options:
Specify actions against the WBEM server's namespace. Default:
Create/update elements.

-r, --remove Remove elements (found in the MOF files) from the WBEM
server's namespace, instead of creating or updating
them
-d, --dry-run Don't actually modify the WBEM server's namespace,
just check MOF syntax. Connection to WBEM server is
still required to check qualifiers.

General options:
-I dir, --include dir
Path name of a MOF include directory. Can be specified
multiple times.
-v, --verbose Print more messages while processing
-V, --version Display pywbem version and exit.
-h, --help Show this help message and exit

Example: mof_compiler CIM_Schema_2.45.mof -s https://localhost -n root/cimv2
-u sheldon -p p42

0 comments on commit 0a55621

Please sign in to comment.