Redfish: implement obtaining AccountService config #9403

paulfertser · 2024-12-26T09:43:33Z

SUMMARY

The AccountService endpoint provides plenty of essential configuration which might be needed to e.g. backup settings or to check the right setup.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

Redfish

ADDITIONAL INFORMATION

Example result from querying OpenBMC's bmcweb Redfish server:

    changed: false
    failed: false
    redfish_facts:
        accountservice_config:
            entries:
                '@odata.id': /redfish/v1/AccountService
                '@odata.type': '#AccountService.v1_15_0.AccountService'
                AccountLockoutDuration: 0
                AccountLockoutThreshold: 0
                Accounts:
                    '@odata.id': /redfish/v1/AccountService/Accounts
                ActiveDirectory:
                    Authentication:
                        AuthenticationType: UsernameAndPassword
                        Password: null
                        Username: ''
                    LDAPService:
                        SearchSettings:
                            BaseDistinguishedNames:
                            - ''
                            GroupsAttribute: ''
                            UsernameAttribute: ''
                    RemoteRoleMapping: []
                    ServiceAddresses:
                    - ''
                    ServiceEnabled: false
                Description: Account Service
                HTTPBasicAuth: Enabled
                HTTPBasicAuth@AllowableValues:
                - Enabled
                - Disabled
                Id: AccountService
                LDAP:
                    Authentication:
                        AuthenticationType: UsernameAndPassword
                        Password: null
                        Username: ''
                    Certificates:
                        '@odata.id': /redfish/v1/AccountService/LDAP/Certificates
                    LDAPService:
                        SearchSettings:
                            BaseDistinguishedNames:
                            - ''
                            GroupsAttribute: ''
                            UsernameAttribute: ''
                    RemoteRoleMapping: []
                    ServiceAddresses:
                    - ''
                    ServiceEnabled: false
                MaxPasswordLength: 20
                MinPasswordLength: 8
                MultiFactorAuth:
                    ClientCertificate:
                        CertificateMappingAttribute: CommonName
                        Certificates:
                            '@odata.id': /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates
                            '@odata.type': '#CertificateCollection.CertificateCollection'
                            Members: []
                            [email protected]: 0
                        Enabled: true
                        RespondToUnauthenticatedClients: true
                Name: Account Service
                Oem:
                    OpenBMC:
                        '@odata.id': /redfish/v1/AccountService#/Oem/OpenBMC
                        '@odata.type': '#OpenBMCAccountService.v1_0_0.AccountService'
                        AuthMethods:
                            BasicAuth: true
                            Cookie: true
                            SessionToken: true
                            TLS: true
                            XToken: true
                Roles:
                    '@odata.id': /redfish/v1/AccountService/Roles
                ServiceEnabled: true
            ret: true

ansibullbot · 2024-12-26T09:51:18Z

cc @TSKushal @Bhavya06 @jyundt @mraineri @rajeevkallur @renxulei @tomasg2012 @xmadsen
click here for bot help

felixfontein

Thanks for your contribution! I've added a first comment below.

changelogs/fragments/9403-redfish-add-get-accountservice.yml

Example result from querying OpenBMC's bmcweb Redfish server: ``` changed: false failed: false redfish_facts: accountservice_config: entries: '@odata.id': /redfish/v1/AccountService '@odata.type': '#AccountService.v1_15_0.AccountService' AccountLockoutDuration: 0 AccountLockoutThreshold: 0 Accounts: '@odata.id': /redfish/v1/AccountService/Accounts ActiveDirectory: Authentication: AuthenticationType: UsernameAndPassword Password: null Username: '' LDAPService: SearchSettings: BaseDistinguishedNames: - '' GroupsAttribute: '' UsernameAttribute: '' RemoteRoleMapping: [] ServiceAddresses: - '' ServiceEnabled: false Description: Account Service HTTPBasicAuth: Enabled HTTPBasicAuth@AllowableValues: - Enabled - Disabled Id: AccountService LDAP: Authentication: AuthenticationType: UsernameAndPassword Password: null Username: '' Certificates: '@odata.id': /redfish/v1/AccountService/LDAP/Certificates LDAPService: SearchSettings: BaseDistinguishedNames: - '' GroupsAttribute: '' UsernameAttribute: '' RemoteRoleMapping: [] ServiceAddresses: - '' ServiceEnabled: false MaxPasswordLength: 20 MinPasswordLength: 8 MultiFactorAuth: ClientCertificate: CertificateMappingAttribute: CommonName Certificates: '@odata.id': /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates '@odata.type': '#CertificateCollection.CertificateCollection' Members: [] [email protected]: 0 Enabled: true RespondToUnauthenticatedClients: true Name: Account Service Oem: OpenBMC: '@odata.id': /redfish/v1/AccountService#/Oem/OpenBMC '@odata.type': '#OpenBMCAccountService.v1_0_0.AccountService' AuthMethods: BasicAuth: true Cookie: true SessionToken: true TLS: true XToken: true Roles: '@odata.id': /redfish/v1/AccountService/Roles ServiceEnabled: true ret: true ``` Signed-off-by: Paul Fertser <[email protected]>

russoz

LGTM from the ansible perspective

mraineri · 2025-01-02T14:56:57Z

Looks good to me! Thanks!

patchback · 2025-01-02T15:26:35Z

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/e853bdf6f907872fdd39e8c507061269399942e9/pr-9403

Backported as #9511

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Example result from querying OpenBMC's bmcweb Redfish server: ``` changed: false failed: false redfish_facts: accountservice_config: entries: '@odata.id': /redfish/v1/AccountService '@odata.type': '#AccountService.v1_15_0.AccountService' AccountLockoutDuration: 0 AccountLockoutThreshold: 0 Accounts: '@odata.id': /redfish/v1/AccountService/Accounts ActiveDirectory: Authentication: AuthenticationType: UsernameAndPassword Password: null Username: '' LDAPService: SearchSettings: BaseDistinguishedNames: - '' GroupsAttribute: '' UsernameAttribute: '' RemoteRoleMapping: [] ServiceAddresses: - '' ServiceEnabled: false Description: Account Service HTTPBasicAuth: Enabled HTTPBasicAuth@AllowableValues: - Enabled - Disabled Id: AccountService LDAP: Authentication: AuthenticationType: UsernameAndPassword Password: null Username: '' Certificates: '@odata.id': /redfish/v1/AccountService/LDAP/Certificates LDAPService: SearchSettings: BaseDistinguishedNames: - '' GroupsAttribute: '' UsernameAttribute: '' RemoteRoleMapping: [] ServiceAddresses: - '' ServiceEnabled: false MaxPasswordLength: 20 MinPasswordLength: 8 MultiFactorAuth: ClientCertificate: CertificateMappingAttribute: CommonName Certificates: '@odata.id': /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates '@odata.type': '#CertificateCollection.CertificateCollection' Members: [] [email protected]: 0 Enabled: true RespondToUnauthenticatedClients: true Name: Account Service Oem: OpenBMC: '@odata.id': /redfish/v1/AccountService#/Oem/OpenBMC '@odata.type': '#OpenBMCAccountService.v1_0_0.AccountService' AuthMethods: BasicAuth: true Cookie: true SessionToken: true TLS: true XToken: true Roles: '@odata.id': /redfish/v1/AccountService/Roles ServiceEnabled: true ret: true ``` Signed-off-by: Paul Fertser <[email protected]> (cherry picked from commit e853bdf)

felixfontein · 2025-01-02T15:26:43Z

@paulfertser thanks for your contribution!
@russoz @mraineri thanks for reviewing this!

…AccountService config (#9511) Redfish: implement obtaining AccountService config (#9403) Example result from querying OpenBMC's bmcweb Redfish server: ``` changed: false failed: false redfish_facts: accountservice_config: entries: '@odata.id': /redfish/v1/AccountService '@odata.type': '#AccountService.v1_15_0.AccountService' AccountLockoutDuration: 0 AccountLockoutThreshold: 0 Accounts: '@odata.id': /redfish/v1/AccountService/Accounts ActiveDirectory: Authentication: AuthenticationType: UsernameAndPassword Password: null Username: '' LDAPService: SearchSettings: BaseDistinguishedNames: - '' GroupsAttribute: '' UsernameAttribute: '' RemoteRoleMapping: [] ServiceAddresses: - '' ServiceEnabled: false Description: Account Service HTTPBasicAuth: Enabled HTTPBasicAuth@AllowableValues: - Enabled - Disabled Id: AccountService LDAP: Authentication: AuthenticationType: UsernameAndPassword Password: null Username: '' Certificates: '@odata.id': /redfish/v1/AccountService/LDAP/Certificates LDAPService: SearchSettings: BaseDistinguishedNames: - '' GroupsAttribute: '' UsernameAttribute: '' RemoteRoleMapping: [] ServiceAddresses: - '' ServiceEnabled: false MaxPasswordLength: 20 MinPasswordLength: 8 MultiFactorAuth: ClientCertificate: CertificateMappingAttribute: CommonName Certificates: '@odata.id': /redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates '@odata.type': '#CertificateCollection.CertificateCollection' Members: [] [email protected]: 0 Enabled: true RespondToUnauthenticatedClients: true Name: Account Service Oem: OpenBMC: '@odata.id': /redfish/v1/AccountService#/Oem/OpenBMC '@odata.type': '#OpenBMCAccountService.v1_0_0.AccountService' AuthMethods: BasicAuth: true Cookie: true SessionToken: true TLS: true XToken: true Roles: '@odata.id': /redfish/v1/AccountService/Roles ServiceEnabled: true ret: true ``` Signed-off-by: Paul Fertser <[email protected]> (cherry picked from commit e853bdf) Co-authored-by: Paul Fertser <[email protected]>

This comment was marked as outdated.

Sign in to view

paulfertser force-pushed the redfish-add-get-accountservice branch 2 times, most recently from 825c11e to 2a820bb Compare December 26, 2024 09:53

ansibullbot removed ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Dec 26, 2024

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-10 Automatically create a backport for the stable-10 branch labels Dec 26, 2024

felixfontein reviewed Dec 26, 2024

View reviewed changes

changelogs/fragments/9403-redfish-add-get-accountservice.yml Outdated Show resolved Hide resolved

paulfertser force-pushed the redfish-add-get-accountservice branch from 2a820bb to eb935b5 Compare December 26, 2024 13:07

russoz reviewed Dec 29, 2024

View reviewed changes

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jan 2, 2025

felixfontein merged commit e853bdf into ansible-collections:main Jan 2, 2025
129 checks passed

patchback bot mentioned this pull request Jan 2, 2025

[PR #9403/e853bdf6 backport][stable-10] Redfish: implement obtaining AccountService config #9511

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redfish: implement obtaining AccountService config #9403

Redfish: implement obtaining AccountService config #9403

paulfertser commented Dec 26, 2024 •

edited

Loading

This comment was marked as outdated.

ansibullbot commented Dec 26, 2024

felixfontein left a comment

russoz left a comment

mraineri commented Jan 2, 2025

patchback bot commented Jan 2, 2025 •

edited

Loading

felixfontein commented Jan 2, 2025

Redfish: implement obtaining AccountService config #9403

Redfish: implement obtaining AccountService config #9403

Conversation

paulfertser commented Dec 26, 2024 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

This comment was marked as outdated.

ansibullbot commented Dec 26, 2024

felixfontein left a comment

Choose a reason for hiding this comment

russoz left a comment

Choose a reason for hiding this comment

mraineri commented Jan 2, 2025

patchback bot commented Jan 2, 2025 • edited Loading

Backport to stable-10: 💚 backport PR created

felixfontein commented Jan 2, 2025

paulfertser commented Dec 26, 2024 •

edited

Loading

patchback bot commented Jan 2, 2025 •

edited

Loading