3.1.5.5 Policy Administration Comments Load Message Sequencing

  • Article

To load the registry-based policy comments from a Group Policy Object (GPO) using an administrative plug-in, the Policy Comment State (section 3.1.1.5) of that GPO on the Group Policy server MUST be read with a new Policy Comment Message (section 2.2.3). This MUST be accomplished with the following message sequence:

  1. Remote File Open from Administrative tool to Server: The file name used MUST be "<gpo path>\comment.cmtx", where <gpo path> is one of the following:

    • The user-scoped Group Policy Object path if the GPO's user settings are being updated.

    • The computer-scoped Group Policy Object path if the computer settings are being updated.

      The remote File Open MUST request Shared Read permissions and MUST specify that the file is not to be created if it does not exist. If the Open request returns a failure status, the Policy Administration Comments Load Message sequence MUST be terminated.

  2. Remote File Open from Administrative tool to Server: The file name used MUST be "<gpo path>\<language locale name>\comment.cmtl", where <language locale name> is in the format language-locale (for example, en-us or fr-fr) and <gpo path> is one of the following:

    • The user-scoped Group Policy Object path if the user settings of the GPO are being updated.

    • The computer-scoped Group Policy Object path if the computer settings are being updated.

      The File Open MUST request Shared Read permission and request that if the file does not exist it will not be created. If the Open request returns a failure status, the Policy Administration Comments Load Message sequence MUST continue with step 3, File Read Sequences.

  3. If the comment.cmtx file is opened, the administrative plug-in MUST perform a series of remote file reads to read the contents of the opened comment.cmtx file. These reads MUST continue until the entire file is read or an error is encountered. If an error is encountered, the protocol sequence MUST be terminated.

    If the comment.cmtl file is opened, the administrative plug-in MUST perform a series of remote file reads to read the contents of the opened comment.cmtl file. These reads MUST continue until the entire file is read or an error is encountered. If an error is encountered, the protocol sequence MUST be terminated.

  4. File Close: The tool MUST then issue a File Close operation for all opened files.