diff --git a/plugins/modules/jenkins_plugin.py b/plugins/modules/jenkins_plugin.py index 14a871188e..b862cf03ac 100644 --- a/plugins/modules/jenkins_plugin.py +++ b/plugins/modules/jenkins_plugin.py @@ -37,7 +37,8 @@ options: name: type: str description: - - Plugin name. + - Unique plugin ID obtained from L(Jenkins Plugin Index, https://plugins.jenkins.io). + See the notes for more information. required: true owner: type: str @@ -134,6 +135,9 @@ options: default: true notes: + - 'Jenkins plugins are required to have I(unique identifiers based on their name), which are used in Plugin Index webpage and + URL slug, C(update-center.json), and C(plugin-versions.json). For example: "C(role-strategy)" for the plugin named Role-based + Authentication Strategy (U(https://plugins.jenkins.io/role-strategy)).' - Plugin installation should be run under root or the same user which owns the plugin files on the disk. Only if the plugin is not installed yet and no version is specified, the API installation is performed which requires only the Web UI credentials. - It is necessary to notify the handler or call the M(ansible.builtin.service) module to restart the Jenkins service after @@ -319,7 +323,7 @@ EXAMPLES = r""" RETURN = r""" plugin: - description: Plugin name. + description: Unique plugin ID based on plugin name. returned: success type: str sample: build-pipeline-plugin