搭配AEM使用cURL

管理員通常需要自動化或簡化任何系統內的常見任務。 例如,在AEM中,管理使用者、安裝套件和管理OSGi套件組合是通常必須完成的工作。

由於建置AEM的Sling架構具有RESTful性質,因此大部分工作都可以透過URL呼叫完成。 cURL可用來執行此類URL呼叫,且對AEM管理員來說也是很實用的工具。

什麼是cURL

cURL是用於執行URL操作的開放原始碼命令列工具。 它支援多種網際網路協定,包括HTTP、HTTPS、FTPS、SCP、SFTP、TFTP、LDAP、DAP、DICT、TELNET、FILE、IMAP、POP3、SMTP和RTSP。

cURL是使用URL語法取得或傳送資料的成熟且廣泛使用的工具,最初於1997年發行。 名稱cURL原本意指「請參閱URL」。

由於建置AEM的Sling架構具有RESTful性質,因此大部分工作都可簡化為URL呼叫,而此呼叫可以使用cURL執行。 使用cURL 可以自動執行內容操作任務(如啟用頁面、啟動工作流 以及操作任務(如包管理和管理用戶)。此外,您還可以為AEM中的大多數任務建立自己的cURL🔗命令。

注意

任何透過cURL執行的AEM命令,都必須像任何使用者一樣獲得AEM的授權。 使用cURL執行AEM命令時,會考量所有ACL和存取權限。

下載cURL

cURL是macOS和某些Linux程式庫的標準部分。 但是,它適用於大多數作業系統。 您可以在https://curl.haxx.se/download.html找到最新下載內容。

您也可以在GitHub上找到cURL的來源存放庫。

建立可用cURL的AEM命令

cURL命令可針對AEM中的大部分操作而建置,例如觸發工作流程、檢查OSGi設定、觸發JMX命令、建立復寫代理等。

若要尋找您特定作業所需的確切命令,您必須在瀏覽器中使用開發人員工具,以在執行AEM命令時擷取對伺服器的POST呼叫。

下列步驟以在Chrome瀏覽器中建立新頁面為例說明如何執行此操作。

  1. 準備要在AEM中叫用的動作。 在此情況下,我們已進入​建立頁面​精靈的結尾,但尚未按一下​建立

    chlimage_1-66

  2. 啟動開發人員工具並選擇​Network​頁簽。 在清除控制台之前,按一下​保留日誌​選項。

    chlimage_1-67

  3. 在​建立頁面​精靈中按一下​建立​以實際建立工作流程。

  4. 按一下右鍵產生的POST動作,然後選取​Copy -> Copy as cURL

    chlimage_1-68

  5. 將cURL命令複製到文本編輯器,並從命令中刪除所有標頭,該標頭以-H開頭(在下圖中以藍色突出顯示),然後添加正確的驗證參數,如-u <user>:<password>

    chlimage_1-69

  6. 通過命令行執行cURL命令並查看響應。

    chlimage_1-70

常見操作AEM cURL命令

以下是常見管理和操作任務的AEM cURL命令清單。

注意

下列範例假設AEM在連接埠4502localhost上執行,並使用密碼admin的使用者admin。 其他命令佔位符設定在角括弧中。

包管理

列出所有已安裝的軟體包

curl -u <user>:<password> http://<host>:<port>/crx/packmgr/service.jsp?cmd=ls

建立包

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=create -d packageName=<name> -d groupName=<name>

預覽包

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=preview

清單包內容

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/console.html/etc/packages/mycontent.zip?cmd=contents

構建包

curl -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=build

重新包裝

curl -u <user>:<password> -X POST http://localhost:4502/crx/packmgr/service/.json/etc/packages/mycontent.zip?cmd=rewrap

更名包

curl -u <user>:<password> -X POST -Fname=<New Name> http://localhost:4502/etc/packages/<Group Name>/<Package Name>.zip/jcr:content/vlt:definition

上傳套件

curl -u <user>:<password> -F cmd=upload -F force=true -F package=@test.zip http://localhost:4502/crx/packmgr/service/.json

安裝軟體包

curl -u <user>:<password> -F cmd=install http://localhost:4502/crx/packmgr/service/.json/etc/packages/my_packages/test.zip

卸載包

curl -u <user>:<password> -F cmd=uninstall http://localhost:4502/crx/packmgr/service/.json/etc/packages/my_packages/test.zip

刪除包

curl -u <user>:<password> -F cmd=delete http://localhost:4502/crx/packmgr/service/.json/etc/packages/my_packages/test.zip

下載包

curl -u <user>:<password> http://localhost:4502/etc/packages/my_packages/test.zip

使用者管理

建立新用戶

curl -u <user>:<password> -FcreateUser= -FauthorizableId=hashim -Frep:password=hashim http://localhost:4502/libs/granite/security/post/authorizables

建立新組

curl -u <user>:<password> -FcreateGroup=group1 -FauthorizableId=testGroup1 http://localhost:4502/libs/granite/security/post/authorizables

將屬性添加到現有用戶

curl -u <user>:<password> -Fprofile/age=25 http://localhost:4502/home/users/h/hashim.rw.html

使用配置檔案建立用戶

curl -u <user>:<password> -FcreateUser=testuser -FauthorizableId=hashimkhan -Frep:password=hashimkhan -Fprofile/gender=male http://localhost:4502/libs/granite/security/post/authorizables

建立新用戶作為組的成員

curl -u <user>:<password> -FcreateUser=testuser -FauthorizableId=testuser -Frep:password=abc123 -Fmembership=contributor http://localhost:4502/libs/granite/security/post/authorizables

將用戶添加到組

curl -u <user>:<password> -FaddMembers=testuser1 http://localhost:4502/home/groups/t/testGroup.rw.html

從組中刪除用戶

curl -u <user>:<password> -FremoveMembers=testuser1 http://localhost:4502/home/groups/t/testGroup.rw.html

設定用戶的組成員資格

curl -u <user>:<password> -Fmembership=contributor -Fmembership=testgroup http://localhost:4502/home/users/t/testuser.rw.html

刪除用戶

curl -u <user>:<password> -FdeleteAuthorizable= http://localhost:4502/home/users/t/testuser

刪除組

curl -u <user>:<password> -FdeleteAuthorizable= http://localhost:4502/home/groups/t/testGroup

備份

有關詳細資訊,請參閱備份和還原

OSGi

啟動套件組合

curl -u <user>:<password> -Faction=start http://localhost:4502/system/console/bundles/<bundle-name>

停止束

curl -u <user>:<password> -Faction=stop http://localhost:4502/system/console/bundles/<bundle-name>

Dispatcher

使快取無效

curl -H "CQ-Action: Activate" -H "CQ-Handle: /content/test-site/" -H "CQ-Path: /content/test-site/" -H "Content-Length: 0" -H "Content-Type: application/octet-stream" http://localhost:4502/dispatcher/invalidate.cache

逐出快取

curl -H "CQ-Action: Deactivate" -H "CQ-Handle: /content/test-site/" -H "CQ-Path: /content/test-site/" -H "Content-Length: 0" -H "Content-Type: application/octet-stream" http://localhost:4502/dispatcher/invalidate.cache

複寫代理

檢查代理的狀態

curl -u <user>:<password> "http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json?agent=publish"
http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json?agent=publish

刪除代理

curl -X DELETE http://localhost:4502/etc/replication/agents.author/replication99 -u <user>:<password>

建立代理

curl -u <user>:<password> -F "jcr:primaryType=cq:Page" -F "jcr:content/jcr:title=new-replication" -F "jcr:content/sling:resourceType=/libs/cq/replication/components/agent" -F "jcr:content/template=/libs/cq/replication/templates/agent" -F "jcr:content/transportUri=http://localhost:4503/bin/receive?sling:authRequestLogin=1" -F "jcr:content/transportUser=admin" -F "jcr:content/transportPassword={DES}8aadb625ced91ac483390ebc10640cdf"http://localhost:4502/etc/replication/agents.author/replication99

暫停代理

curl -u <user>:<password> -F "cmd=pause" -F "name=publish"  http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json

清除代理隊列

curl -u <user>:<password> -F "cmd=clear" -F "name=publish"  http://localhost:4502/etc/replication/agents.author/publish/jcr:content.queue.json

社群

分配和撤消徽章

如需詳細資訊,請參閱Communities計分和徽章

有關詳細資訊,請參閱計分和徽章要點

MSRP重新索引

如需詳細資訊,請參閱MSRP - MongoDB儲存資源提供者

安全性

啟用和禁用CRX DE Lite

如需詳細資訊,請參閱在AEM中啟用CRXDE Lite。

資料存放庫廢棄項目收集

有關詳細資訊,請參閱資料儲存垃圾收集

Analytics與Target整合

如需詳細資訊,請參閱選擇加入Adobe Analytics和Adobe Target

單一登入

傳送測試標題

如需詳細資訊,請參閱單一登入

常見內容操作AEM cURL命令

以下是用於內容操控的AEM cURL命令清單。

注意

下列範例假設AEM在連接埠4502localhost上執行,並使用密碼admin的使用者admin。 其他命令佔位符設定在角括弧中。

頁面管理

頁面啟動

curl -u <user>:<password> -X POST -F path="/content/path/to/page" -F cmd="activate" http://localhost:4502/bin/replicate.json

頁面停用

curl -u <user>:<password> -X POST -F path="/content/path/to/page" -F cmd="deactivate" http://localhost:4502/bin/replicate.json

樹激活

curl -u <user>:<password> -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/geometrixx http://localhost:4502/etc/replication/treeactivation.html

鎖定頁面

curl -u <user>:<password> -X POST -F cmd="lockPage" -F path="/content/path/to/page" -F "_charset_"="utf-8" http://localhost:4502/bin/wcmcommand

解鎖頁面

curl -u <user>:<password> -X POST -F cmd="unlockPage" -F path="/content/path/to/page" -F "_charset_"="utf-8" http://localhost:4502/bin/wcmcommand

複製頁面

curl -u <user>:<password> -F cmd=copyPage -F destParentPath=/path/to/destination/parent -F srcPath=/path/to/source/location http://localhost:4502/bin/wcmcommand

工作流程

如需詳細資訊,請參閱以程式設計方式與工作流程互動

Sling內容

建立資料夾

curl -u <user>:<password> -F jcr:primaryType=sling:Folder http://localhost:4502/etc/test

刪除節點

curl -u <user>:<password> -F :operation=delete http://localhost:4502/etc/test/test.properties

移動節點

curl -u <user>:<password> -F":operation=move" -F":applyTo=/sourceurl"  -F":dest=/target/parenturl/" https://localhost:4502/content

複製節點

curl -u <user>:<password> -F":operation=copy" -F":applyTo=/sourceurl"  -F":dest=/target/parenturl/" https://localhost:4502/content

使用Sling PostServlet上傳檔案

curl -u <user>:<password> -F"*=@test.properties"  http://localhost:4502/etc/test

使用Sling PostServlet上傳檔案並指定節點名稱

curl -u <user>:<password> -F"test2.properties=@test.properties"  http://localhost:4502/etc/test

指定內容類型的上載檔案

curl -u <user>:<password> -F "*=@test.properties;type=text/plain" http://localhost:4502/etc/test

資產操作

如需詳細資訊,請參閱資產HTTP API

本頁內容